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  * Check whether a complete SCPI response has been received.
 342  *
 343  * @param scpi Previously initialised SCPI device structure.
 344  *
 345  * @return 1 if complete, 0 otherwise.
 346  */
 347 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
 348 {
 349         return scpi->read_complete(scpi->priv);
 350 }
 351
 352 /**
 353  * Close SCPI device.
 354  *
 355  * @param scpi Previously initialized SCPI device structure.
 356  *
 357  * @return SR_OK on success, SR_ERR on failure.
 358  */
 359 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
 360 {
 361         return scpi->close(scpi);
 362 }
 363
 364 /**
 365  * Free SCPI device.
 366  *
 367  * @param scpi Previously initialized SCPI device structure. If NULL,
 368  *             this function does nothing.
 369  */
 370 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
 371 {
 372         if (!scpi)
 373                 return;
 374
 375         scpi->free(scpi->priv);
 376         g_free(scpi->priv);
 377         g_free(scpi);
 378 }
 379
 380 /**
 381  * Send a SCPI command, receive the reply and store the reply in scpi_response.
 382  *
 383  * @param scpi Previously initialised SCPI device structure.
 384  * @param command The SCPI command to send to the device (can be NULL).
 385  * @param scpi_response Pointer where to store the SCPI response.
 386  *
 387  * @return SR_OK on success, SR_ERR* on failure.
 388  */
 389 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
 390                                const char *command, char **scpi_response)
 391 {
 392         GString *response;
 393         response = g_string_sized_new(1024);
 394
 395         if (sr_scpi_get_data(scpi, command, &response) != SR_OK) {
 396                 if (response)
 397                         g_string_free(response, TRUE);
 398                 return SR_ERR;
 399         }
 400
 401         /* Get rid of trailing linefeed if present */
 402         if (response->len >= 1 && response->str[response->len - 1] == '\n')
 403                 g_string_truncate(response, response->len - 1);
 404
 405         /* Get rid of trailing carriage return if present */
 406         if (response->len >= 1 && response->str[response->len - 1] == '\r')
 407                 g_string_truncate(response, response->len - 1);
 408
 409         sr_spew("Got response: '%.70s', length %" G_GSIZE_FORMAT ".",
 410                 response->str, response->len);
 411
 412         *scpi_response = g_string_free(response, FALSE);
 413
 414         return SR_OK;
 415 }
 416
 417 /**
 418  * Do a non-blocking read of up to the allocated length, and
 419  * check if a timeout has occured.
 420  *
 421  * @param scpi Previously initialised SCPI device structure.
 422  * @param response Buffer to which the response is appended.
 423  * @param abs_timeout_us Absolute timeout in microseconds
 424  *
 425  * @return read length on success, SR_ERR* on failure.
 426  */
 427 SR_PRIV int sr_scpi_read_response(struct sr_scpi_dev_inst *scpi,
 428                                   GString *response, gint64 abs_timeout_us)
 429 {
 430         int len, space;
 431
 432         space = response->allocated_len - response->len;
 433         len = sr_scpi_read_data(scpi, &response->str[response->len], space);
 434
 435         if (len < 0) {
 436                 sr_err("Incompletely read SCPI response.");
 437                 return SR_ERR;
 438         }
 439
 440         if (len > 0) {
 441                 g_string_set_size(response, response->len + len);
 442                 return len;
 443         }
 444
 445         if (g_get_monotonic_time() > abs_timeout_us) {
 446                 sr_err("Timed out waiting for SCPI response.");
 447                 return SR_ERR_TIMEOUT;
 448         }
 449
 450         return 0;
 451 }
 452
 453 SR_PRIV int sr_scpi_get_data(struct sr_scpi_dev_inst *scpi,
 454                              const char *command, GString **scpi_response)
 455 {
 456         int ret;
 457         GString *response;
 458         int space;
 459         gint64 timeout;
 460
 461         /* Optionally send caller provided command. */
 462         if (command) {
 463                 if (sr_scpi_send(scpi, command) != SR_OK)
 464                         return SR_ERR;
 465         }
 466
 467         /* Initiate SCPI read operation. */
 468         if (sr_scpi_read_begin(scpi) != SR_OK)
 469                 return SR_ERR;
 470
 471         /* Keep reading until completion or until timeout. */
 472         timeout = g_get_monotonic_time() + scpi->read_timeout_us;
 473
 474         response = *scpi_response;
 475
 476         while (!sr_scpi_read_complete(scpi)) {
 477                 /* Resize the buffer when free space drops below a threshold. */
 478                 space = response->allocated_len - response->len;
 479                 if (space < 128) {
 480                         int oldlen = response->len;
 481                         g_string_set_size(response, oldlen + 1024);
 482                         g_string_set_size(response, oldlen);
 483                 }
 484
 485                 /* Read another chunk of the response. */
 486                 ret = sr_scpi_read_response(scpi, response, timeout);
 487
 488                 if (ret < 0)
 489                         return ret;
 490                 if (ret > 0)
 491                         timeout = g_get_monotonic_time() + scpi->read_timeout_us;
 492         }
 493
 494         return SR_OK;
 495 }
 496
 497 /**
 498  * Send a SCPI command, read the reply, parse it as a bool value and store the
 499  * result in scpi_response.
 500  *
 501  * @param scpi Previously initialised SCPI device structure.
 502  * @param command The SCPI command to send to the device (can be NULL).
 503  * @param scpi_response Pointer where to store the parsed result.
 504  *
 505  * @return SR_OK on success, SR_ERR* on failure.
 506  */
 507 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
 508                              const char *command, gboolean *scpi_response)
 509 {
 510         int ret;
 511         char *response;
 512
 513         response = NULL;
 514
 515         ret = sr_scpi_get_string(scpi, command, &response);
 516         if (ret != SR_OK && !response)
 517                 return ret;
 518
 519         if (parse_strict_bool(response, scpi_response) == SR_OK)
 520                 ret = SR_OK;
 521         else
 522                 ret = SR_ERR_DATA;
 523
 524         g_free(response);
 525
 526         return ret;
 527 }
 528
 529 /**
 530  * Send a SCPI command, read the reply, parse it as an integer and store the
 531  * result in scpi_response.
 532  *
 533  * @param scpi Previously initialised SCPI device structure.
 534  * @param command The SCPI command to send to the device (can be NULL).
 535  * @param scpi_response Pointer where to store the parsed result.
 536  *
 537  * @return SR_OK on success, SR_ERR* on failure.
 538  */
 539 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
 540                             const char *command, int *scpi_response)
 541 {
 542         int ret;
 543         char *response;
 544
 545         response = NULL;
 546
 547         ret = sr_scpi_get_string(scpi, command, &response);
 548         if (ret != SR_OK && !response)
 549                 return ret;
 550
 551         if (sr_atoi(response, scpi_response) == SR_OK)
 552                 ret = SR_OK;
 553         else
 554                 ret = SR_ERR_DATA;
 555
 556         g_free(response);
 557
 558         return ret;
 559 }
 560
 561 /**
 562  * Send a SCPI command, read the reply, parse it as a float and store the
 563  * result in scpi_response.
 564  *
 565  * @param scpi Previously initialised SCPI device structure.
 566  * @param command The SCPI command to send to the device (can be NULL).
 567  * @param scpi_response Pointer where to store the parsed result.
 568  *
 569  * @return SR_OK on success, SR_ERR* on failure.
 570  */
 571 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
 572                               const char *command, float *scpi_response)
 573 {
 574         int ret;
 575         char *response;
 576
 577         response = NULL;
 578
 579         ret = sr_scpi_get_string(scpi, command, &response);
 580         if (ret != SR_OK && !response)
 581                 return ret;
 582
 583         if (sr_atof_ascii(response, scpi_response) == SR_OK)
 584                 ret = SR_OK;
 585         else
 586                 ret = SR_ERR_DATA;
 587
 588         g_free(response);
 589
 590         return ret;
 591 }
 592
 593 /**
 594  * Send a SCPI command, read the reply, parse it as a double and store the
 595  * result in scpi_response.
 596  *
 597  * @param scpi Previously initialised SCPI device structure.
 598  * @param command The SCPI command to send to the device (can be NULL).
 599  * @param scpi_response Pointer where to store the parsed result.
 600  *
 601  * @return SR_OK on success, SR_ERR* on failure.
 602  */
 603 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
 604                                const char *command, double *scpi_response)
 605 {
 606         int ret;
 607         char *response;
 608
 609         response = NULL;
 610
 611         ret = sr_scpi_get_string(scpi, command, &response);
 612         if (ret != SR_OK && !response)
 613                 return ret;
 614
 615         if (sr_atod(response, scpi_response) == SR_OK)
 616                 ret = SR_OK;
 617         else
 618                 ret = SR_ERR_DATA;
 619
 620         g_free(response);
 621
 622         return ret;
 623 }
 624
 625 /**
 626  * Send a SCPI *OPC? command, read the reply and return the result of the
 627  * command.
 628  *
 629  * @param scpi Previously initialised SCPI device structure.
 630  *
 631  * @return SR_OK on success, SR_ERR* on failure.
 632  */
 633 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
 634 {
 635         unsigned int i;
 636         gboolean opc;
 637
 638         for (i = 0; i < SCPI_READ_RETRIES; i++) {
 639                 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
 640                 if (opc)
 641                         return SR_OK;
 642                 g_usleep(SCPI_READ_RETRY_TIMEOUT_US);
 643         }
 644
 645         return SR_ERR;
 646 }
 647
 648 /**
 649  * Send a SCPI command, read the reply, parse it as comma separated list of
 650  * floats and store the as an result in scpi_response.
 651  *
 652  * @param scpi Previously initialised SCPI device structure.
 653  * @param command The SCPI command to send to the device (can be NULL).
 654  * @param scpi_response Pointer where to store the parsed result.
 655  *
 656  * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
 657  *         error or upon no response. The allocated response must be freed by
 658  *         the caller in the case of an SR_OK as well as in the case of
 659  *         parsing error.
 660  */
 661 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
 662                                const char *command, GArray **scpi_response)
 663 {
 664         int ret;
 665         float tmp;
 666         char *response;
 667         gchar **ptr, **tokens;
 668         GArray *response_array;
 669
 670         response = NULL;
 671         tokens = NULL;
 672
 673         ret = sr_scpi_get_string(scpi, command, &response);
 674         if (ret != SR_OK && !response)
 675                 return ret;
 676
 677         tokens = g_strsplit(response, ",", 0);
 678         ptr = tokens;
 679
 680         response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
 681
 682         while (*ptr) {
 683                 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
 684                         response_array = g_array_append_val(response_array,
 685                                                             tmp);
 686                 else
 687                         ret = SR_ERR_DATA;
 688
 689                 ptr++;
 690         }
 691         g_strfreev(tokens);
 692         g_free(response);
 693
 694         if (ret != SR_OK && response_array->len == 0) {
 695                 g_array_free(response_array, TRUE);
 696                 *scpi_response = NULL;
 697                 return SR_ERR_DATA;
 698         }
 699
 700         *scpi_response = response_array;
 701
 702         return ret;
 703 }
 704
 705 /**
 706  * Send a SCPI command, read the reply, parse it as comma separated list of
 707  * unsigned 8 bit integers and store the as an result in scpi_response.
 708  *
 709  * @param scpi Previously initialised SCPI device structure.
 710  * @param command The SCPI command to send to the device (can be NULL).
 711  * @param scpi_response Pointer where to store the parsed result.
 712  *
 713  * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
 714  *         error or upon no response. The allocated response must be freed by
 715  *         the caller in the case of an SR_OK as well as in the case of
 716  *         parsing error.
 717  */
 718 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
 719                                const char *command, GArray **scpi_response)
 720 {
 721         int tmp, ret;
 722         char *response;
 723         gchar **ptr, **tokens;
 724         GArray *response_array;
 725
 726         response = NULL;
 727         tokens = NULL;
 728
 729         ret = sr_scpi_get_string(scpi, command, &response);
 730         if (ret != SR_OK && !response)
 731                 return ret;
 732
 733         tokens = g_strsplit(response, ",", 0);
 734         ptr = tokens;
 735
 736         response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
 737
 738         while (*ptr) {
 739                 if (sr_atoi(*ptr, &tmp) == SR_OK)
 740                         response_array = g_array_append_val(response_array,
 741                                                             tmp);
 742                 else
 743                         ret = SR_ERR_DATA;
 744
 745                 ptr++;
 746         }
 747         g_strfreev(tokens);
 748         g_free(response);
 749
 750         if (response_array->len == 0) {
 751                 g_array_free(response_array, TRUE);
 752                 *scpi_response = NULL;
 753                 return SR_ERR_DATA;
 754         }
 755
 756         *scpi_response = response_array;
 757
 758         return ret;
 759 }
 760
 761 /**
 762  * Send a SCPI command, read the reply, parse it as binary data with a
 763  * "definite length block" header and store the as an result in scpi_response.
 764  *
 765  * @param scpi Previously initialised SCPI device structure.
 766  * @param command The SCPI command to send to the device (can be NULL).
 767  * @param scpi_response Pointer where to store the parsed result.
 768  *
 769  * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
 770  *         error or upon no response. The allocated response must be freed by
 771  *         the caller in the case of an SR_OK as well as in the case of
 772  *         parsing error.
 773  */
 774 SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
 775                                const char *command, GByteArray **scpi_response)
 776 {
 777         int ret;
 778         GString* response;
 779         char buf[10];
 780         long llen;
 781         long datalen;
 782         gint64 timeout;
 783
 784         if (command)
 785                 if (sr_scpi_send(scpi, command) != SR_OK)
 786                         return SR_ERR;
 787
 788         if (sr_scpi_read_begin(scpi) != SR_OK)
 789                 return SR_ERR;
 790
 791         /*
 792          * Assume an initial maximum length, optionally gets adjusted below.
 793          * Prepare a NULL return value for when error paths will be taken.
 794          */
 795         response = g_string_sized_new(1024);
 796
 797         timeout = g_get_monotonic_time() + scpi->read_timeout_us;
 798
 799         *scpi_response = NULL;
 800
 801         /* Get (the first chunk of) the response. */
 802         while (response->len < 2) {
 803                 ret = sr_scpi_read_response(scpi, response, timeout);
 804                 if (ret < 0) {
 805                         g_string_free(response, TRUE);
 806                         return ret;
 807                 }
 808         }
 809
 810         /*
 811          * SCPI protocol data blocks are preceeded with a length spec.
 812          * The length spec consists of a '#' marker, one digit which
 813          * specifies the character count of the length spec, and the
 814          * respective number of characters which specify the data block's
 815          * length. Raw data bytes follow (thus one must no longer assume
 816          * that the received input stream would be an ASCIIZ string).
 817          *
 818          * Get the data block length, and strip off the length spec from
 819          * the input buffer, leaving just the data bytes.
 820          */
 821         if (response->str[0] != '#') {
 822                 g_string_free(response, TRUE);
 823                 return SR_ERR_DATA;
 824         }
 825         buf[0] = response->str[1];
 826         buf[1] = '\0';
 827         ret = sr_atol(buf, &llen);
 828         if ((ret != SR_OK) || (llen == 0)) {
 829                 g_string_free(response, TRUE);
 830                 return ret;
 831         }
 832
 833         while (response->len < (unsigned long)(2 + llen)) {
 834                 ret = sr_scpi_read_response(scpi, response, timeout);
 835                 if (ret < 0) {
 836                         g_string_free(response, TRUE);
 837                         return ret;
 838                 }
 839         }
 840
 841         memcpy(buf, &response->str[2], llen);
 842         buf[llen] = '\0';
 843         ret = sr_atol(buf, &datalen);
 844         if ((ret != SR_OK) || (datalen == 0)) {
 845                 g_string_free(response, TRUE);
 846                 return ret;
 847         }
 848         g_string_erase(response, 0, 2 + llen);
 849
 850         /*
 851          * If the initially assumed length does not cover the data block
 852          * length, then re-allocate the buffer size to the now known
 853          * length, and keep reading more chunks of response data.
 854          */
 855         if (response->len < (unsigned long)(datalen)) {
 856                 int oldlen = response->len;
 857                 g_string_set_size(response, datalen);
 858                 g_string_set_size(response, oldlen);
 859         }
 860
 861         while (response->len < (unsigned long)(datalen)) {
 862                 ret = sr_scpi_read_response(scpi, response, timeout);
 863                 if (ret < 0) {
 864                         g_string_free(response, TRUE);
 865                         return ret;
 866                 }
 867                 if (ret > 0)
 868                         timeout = g_get_monotonic_time() + scpi->read_timeout_us;
 869         }
 870
 871         /* Convert received data to byte array. */
 872         *scpi_response = g_byte_array_new_take(
 873                 (guint8*)g_string_free(response, FALSE), datalen);
 874
 875         return SR_OK;
 876 }
 877
 878 /**
 879  * Send the *IDN? SCPI command, receive the reply, parse it and store the
 880  * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
 881  *
 882  * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
 883  *
 884  * @param scpi Previously initialised SCPI device structure.
 885  * @param scpi_response Pointer where to store the hw_info structure.
 886  *
 887  * @return SR_OK upon success, SR_ERR* on failure.
 888  */
 889 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
 890                               struct sr_scpi_hw_info **scpi_response)
 891 {
 892         int num_tokens, ret;
 893         char *response;
 894         gchar **tokens;
 895         struct sr_scpi_hw_info *hw_info;
 896
 897         response = NULL;
 898         tokens = NULL;
 899
 900         ret = sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response);
 901         if (ret != SR_OK && !response)
 902                 return ret;
 903
 904         sr_info("Got IDN string: '%s'", response);
 905
 906         /*
 907          * The response to a '*IDN?' is specified by the SCPI spec. It contains
 908          * a comma-separated list containing the manufacturer name, instrument
 909          * model, serial number of the instrument and the firmware version.
 910          */
 911         tokens = g_strsplit(response, ",", 0);
 912
 913         for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
 914
 915         if (num_tokens < 4) {
 916                 sr_dbg("IDN response not according to spec: %80.s.", response);
 917                 g_strfreev(tokens);
 918                 g_free(response);
 919                 return SR_ERR_DATA;
 920         }
 921         g_free(response);
 922
 923         hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info));
 924         hw_info->manufacturer = g_strstrip(g_strdup(tokens[0]));
 925         hw_info->model = g_strstrip(g_strdup(tokens[1]));
 926         hw_info->serial_number = g_strstrip(g_strdup(tokens[2]));
 927         hw_info->firmware_version = g_strstrip(g_strdup(tokens[3]));
 928
 929         g_strfreev(tokens);
 930
 931         *scpi_response = hw_info;
 932
 933         return SR_OK;
 934 }
 935
 936 /**
 937  * Free a sr_scpi_hw_info struct.
 938  *
 939  * @param hw_info Pointer to the struct to free. If NULL, this
 940  *                function does nothing.
 941  */
 942 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
 943 {
 944         if (!hw_info)
 945                 return;
 946
 947         g_free(hw_info->manufacturer);
 948         g_free(hw_info->model);
 949         g_free(hw_info->serial_number);
 950         g_free(hw_info->firmware_version);
 951         g_free(hw_info);
 952 }