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  * Copyright (C) 2015 Bert Vermeulen <bert@biot.com>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include <config.h>
  22 #include <glib.h>
  23 #include <string.h>
  24 #include <libsigrok/libsigrok.h>
  25 #include "libsigrok-internal.h"
  26 #include "scpi.h"
  27
  28 #define LOG_PREFIX "scpi"
  29
  30 #define SCPI_READ_RETRIES 100
  31 #define SCPI_READ_RETRY_TIMEOUT_US (10 * 1000)
  32
  33 static const char *scpi_vendors[][2] = {
  34         { "Agilent Technologies", "Agilent" },
  35         { "CHROMA", "Chroma" },
  36         { "Chroma ATE", "Chroma" },
  37         { "HEWLETT-PACKARD", "HP" },
  38         { "Keysight Technologies", "Keysight" },
  39         { "PHILIPS", "Philips" },
  40         { "RIGOL TECHNOLOGIES", "Rigol" },
  41 };
  42
  43 /**
  44  * Parse a string representation of a boolean-like value into a gboolean.
  45  * Similar to sr_parse_boolstring but rejects strings which do not represent
  46  * a boolean-like value.
  47  *
  48  * @param str String to convert.
  49  * @param ret Pointer to a gboolean where the result of the conversion will be
  50  * stored.
  51  *
  52  * @return SR_OK on success, SR_ERR on failure.
  53  */
  54 static int parse_strict_bool(const char *str, gboolean *ret)
  55 {
  56         if (!str)
  57                 return SR_ERR_ARG;
  58
  59         if (!g_strcmp0(str, "1") ||
  60             !g_ascii_strncasecmp(str, "y", 1) ||
  61             !g_ascii_strncasecmp(str, "t", 1) ||
  62             !g_ascii_strncasecmp(str, "yes", 3) ||
  63             !g_ascii_strncasecmp(str, "true", 4) ||
  64             !g_ascii_strncasecmp(str, "on", 2)) {
  65                 *ret = TRUE;
  66                 return SR_OK;
  67         } else if (!g_strcmp0(str, "0") ||
  68                    !g_ascii_strncasecmp(str, "n", 1) ||
  69                    !g_ascii_strncasecmp(str, "f", 1) ||
  70                    !g_ascii_strncasecmp(str, "no", 2) ||
  71                    !g_ascii_strncasecmp(str, "false", 5) ||
  72                    !g_ascii_strncasecmp(str, "off", 3)) {
  73                 *ret = FALSE;
  74                 return SR_OK;
  75         }
  76
  77         return SR_ERR;
  78 }
  79
  80 SR_PRIV extern const struct sr_scpi_dev_inst scpi_serial_dev;
  81 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_raw_dev;
  82 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_rigol_dev;
  83 SR_PRIV extern const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev;
  84 SR_PRIV extern const struct sr_scpi_dev_inst scpi_vxi_dev;
  85 SR_PRIV extern const struct sr_scpi_dev_inst scpi_visa_dev;
  86 SR_PRIV extern const struct sr_scpi_dev_inst scpi_libgpib_dev;
  87
  88 static const struct sr_scpi_dev_inst *scpi_devs[] = {
  89         &scpi_tcp_raw_dev,
  90         &scpi_tcp_rigol_dev,
  91 #ifdef HAVE_LIBUSB_1_0
  92         &scpi_usbtmc_libusb_dev,
  93 #endif
  94 #if HAVE_RPC
  95         &scpi_vxi_dev,
  96 #endif
  97 #ifdef HAVE_LIBREVISA
  98         &scpi_visa_dev,
  99 #endif
 100 #ifdef HAVE_LIBGPIB
 101         &scpi_libgpib_dev,
 102 #endif
 103 #ifdef HAVE_SERIAL_COMM
 104         &scpi_serial_dev, /* Must be last as it matches any resource. */
 105 #endif
 106 };
 107
 108 static struct sr_dev_inst *sr_scpi_scan_resource(struct drv_context *drvc,
 109                 const char *resource, const char *serialcomm,
 110                 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
 111 {
 112         struct sr_scpi_dev_inst *scpi;
 113         struct sr_dev_inst *sdi;
 114
 115         if (!(scpi = scpi_dev_inst_new(drvc, resource, serialcomm)))
 116                 return NULL;
 117
 118         if (sr_scpi_open(scpi) != SR_OK) {
 119                 sr_info("Couldn't open SCPI device.");
 120                 sr_scpi_free(scpi);
 121                 return NULL;
 122         };
 123
 124         sdi = probe_device(scpi);
 125
 126         sr_scpi_close(scpi);
 127
 128         if (sdi)
 129                 sdi->status = SR_ST_INACTIVE;
 130         else
 131                 sr_scpi_free(scpi);
 132
 133         return sdi;
 134 }
 135
 136 /**
 137  * Send a SCPI command with a variadic argument list without mutex.
 138  *
 139  * @param scpi Previously initialized SCPI device structure.
 140  * @param format Format string.
 141  * @param args Argument list.
 142  *
 143  * @return SR_OK on success, SR_ERR on failure.
 144  */
 145 static int scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
 146                          const char *format, va_list args)
 147 {
 148         va_list args_copy;
 149         char *buf;
 150         int len, ret;
 151
 152         /* Get length of buffer required. */
 153         va_copy(args_copy, args);
 154         len = sr_vsnprintf_ascii(NULL, 0, format, args_copy);
 155         va_end(args_copy);
 156
 157         /* Allocate buffer and write out command. */
 158         buf = g_malloc0(len + 2);
 159         sr_vsprintf_ascii(buf, format, args);
 160         if (buf[len - 1] != '\n')
 161                 buf[len] = '\n';
 162
 163         /* Send command. */
 164         ret = scpi->send(scpi->priv, buf);
 165
 166         /* Free command buffer. */
 167         g_free(buf);
 168
 169         return ret;
 170 }
 171
 172 /**
 173  * Send a SCPI command without mutex.
 174  *
 175  * @param scpi Previously initialized SCPI device structure.
 176  * @param format Format string, to be followed by any necessary arguments.
 177  *
 178  * @return SR_OK on success, SR_ERR on failure.
 179  */
 180 static int scpi_send(struct sr_scpi_dev_inst *scpi, const char *format, ...)
 181 {
 182         va_list args;
 183         int ret;
 184
 185         va_start(args, format);
 186         ret = scpi_send_variadic(scpi, format, args);
 187         va_end(args);
 188
 189         return ret;
 190 }
 191
 192 /**
 193  * Send data to SCPI device without mutex.
 194  *
 195  * TODO: This is only implemented in TcpRaw, but never used.
 196  * TODO: Use Mutex at all?
 197  *
 198  * @param scpi Previously initialised SCPI device structure.
 199  * @param buf Buffer with data to send.
 200  * @param len Number of bytes to send.
 201  *
 202  * @return Number of bytes read, or SR_ERR upon failure.
 203  */
 204 static int scpi_write_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen)
 205 {
 206         return scpi->write_data(scpi->priv, buf, maxlen);
 207 }
 208
 209 /**
 210  * Read part of a response from SCPI device without mutex.
 211  *
 212  * @param scpi Previously initialised SCPI device structure.
 213  * @param buf Buffer to store result.
 214  * @param maxlen Maximum number of bytes to read.
 215  *
 216  * @return Number of bytes read, or SR_ERR upon failure.
 217  */
 218 static int scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen)
 219 {
 220         return scpi->read_data(scpi->priv, buf, maxlen);
 221 }
 222
 223 /**
 224  * Do a non-blocking read of up to the allocated length, and
 225  * check if a timeout has occured, without mutex.
 226  *
 227  * @param scpi Previously initialised SCPI device structure.
 228  * @param response Buffer to which the response is appended.
 229  * @param abs_timeout_us Absolute timeout in microseconds
 230  *
 231  * @return read length on success, SR_ERR* on failure.
 232  */
 233 static int scpi_read_response(struct sr_scpi_dev_inst *scpi,
 234                                 GString *response, gint64 abs_timeout_us)
 235 {
 236         int len, space;
 237
 238         space = response->allocated_len - response->len;
 239         len = scpi->read_data(scpi->priv, &response->str[response->len], space);
 240
 241         if (len < 0) {
 242                 sr_err("Incompletely read SCPI response.");
 243                 return SR_ERR;
 244         }
 245
 246         if (len > 0) {
 247                 g_string_set_size(response, response->len + len);
 248                 return len;
 249         }
 250
 251         if (g_get_monotonic_time() > abs_timeout_us) {
 252                 sr_err("Timed out waiting for SCPI response.");
 253                 return SR_ERR_TIMEOUT;
 254         }
 255
 256         return 0;
 257 }
 258
 259 /**
 260  * Send a SCPI command, receive the reply and store the reply in
 261  * scpi_response, without mutex.
 262  *
 263  * @param scpi Previously initialised SCPI device structure.
 264  * @param command The SCPI command to send to the device.
 265  * @param scpi_response Pointer where to store the SCPI response.
 266  *
 267  * @return SR_OK on success, SR_ERR on failure.
 268  */
 269 static int scpi_get_data(struct sr_scpi_dev_inst *scpi,
 270                                 const char *command, GString **scpi_response)
 271 {
 272         int ret;
 273         GString *response;
 274         int space;
 275         gint64 timeout;
 276
 277         /* Optionally send caller provided command. */
 278         if (command) {
 279                 if (scpi_send(scpi, command) != SR_OK)
 280                         return SR_ERR;
 281         }
 282
 283         /* Initiate SCPI read operation. */
 284         if (sr_scpi_read_begin(scpi) != SR_OK)
 285                 return SR_ERR;
 286
 287         /* Keep reading until completion or until timeout. */
 288         timeout = g_get_monotonic_time() + scpi->read_timeout_us;
 289
 290         response = *scpi_response;
 291
 292         while (!sr_scpi_read_complete(scpi)) {
 293                 /* Resize the buffer when free space drops below a threshold. */
 294                 space = response->allocated_len - response->len;
 295                 if (space < 128) {
 296                         int oldlen = response->len;
 297                         g_string_set_size(response, oldlen + 1024);
 298                         g_string_set_size(response, oldlen);
 299                 }
 300
 301                 /* Read another chunk of the response. */
 302                 ret = scpi_read_response(scpi, response, timeout);
 303
 304                 if (ret < 0)
 305                         return ret;
 306                 if (ret > 0)
 307                         timeout = g_get_monotonic_time() + scpi->read_timeout_us;
 308         }
 309
 310         return SR_OK;
 311 }
 312
 313 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
 314                 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
 315 {
 316         GSList *resources, *l, *devices;
 317         struct sr_dev_inst *sdi;
 318         const char *resource = NULL;
 319         const char *serialcomm = NULL;
 320         gchar **res;
 321         unsigned i;
 322
 323         for (l = options; l; l = l->next) {
 324                 struct sr_config *src = l->data;
 325                 switch (src->key) {
 326                 case SR_CONF_CONN:
 327                         resource = g_variant_get_string(src->data, NULL);
 328                         break;
 329                 case SR_CONF_SERIALCOMM:
 330                         serialcomm = g_variant_get_string(src->data, NULL);
 331                         break;
 332                 }
 333         }
 334
 335         devices = NULL;
 336         for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
 337                 if ((resource && strcmp(resource, scpi_devs[i]->prefix))
 338                     || !scpi_devs[i]->scan)
 339                         continue;
 340                 resources = scpi_devs[i]->scan(drvc);
 341                 for (l = resources; l; l = l->next) {
 342                         res = g_strsplit(l->data, ":", 2);
 343                         if (res[0] && (sdi = sr_scpi_scan_resource(drvc, res[0],
 344                                        serialcomm ? serialcomm : res[1], probe_device))) {
 345                                 devices = g_slist_append(devices, sdi);
 346                                 sdi->connection_id = g_strdup(l->data);
 347                         }
 348                         g_strfreev(res);
 349                 }
 350                 g_slist_free_full(resources, g_free);
 351         }
 352
 353         if (!devices && resource) {
 354                 sdi = sr_scpi_scan_resource(drvc, resource, serialcomm, probe_device);
 355                 if (sdi)
 356                         devices = g_slist_append(NULL, sdi);
 357         }
 358
 359         /* Tack a copy of the newly found devices onto the driver list. */
 360         if (devices)
 361                 drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
 362
 363         return devices;
 364 }
 365
 366 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
 367                 const char *resource, const char *serialcomm)
 368 {
 369         struct sr_scpi_dev_inst *scpi = NULL;
 370         const struct sr_scpi_dev_inst *scpi_dev;
 371         gchar **params;
 372         unsigned i;
 373
 374         for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
 375                 scpi_dev = scpi_devs[i];
 376                 if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) {
 377                         sr_dbg("Opening %s device %s.", scpi_dev->name, resource);
 378                         scpi = g_malloc(sizeof(*scpi));
 379                         *scpi = *scpi_dev;
 380                         scpi->priv = g_malloc0(scpi->priv_size);
 381                         scpi->read_timeout_us = 1000 * 1000;
 382                         params = g_strsplit(resource, "/", 0);
 383                         if (scpi->dev_inst_new(scpi->priv, drvc, resource,
 384                                                params, serialcomm) != SR_OK) {
 385                                 sr_scpi_free(scpi);
 386                                 scpi = NULL;
 387                         }
 388                         g_strfreev(params);
 389                         break;
 390                 }
 391         }
 392
 393         return scpi;
 394 }
 395
 396 /**
 397  * Open SCPI device.
 398  *
 399  * @param scpi Previously initialized SCPI device structure.
 400  *
 401  * @return SR_OK on success, SR_ERR on failure.
 402  */
 403 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
 404 {
 405         g_mutex_init(&scpi->scpi_mutex);
 406
 407         return scpi->open(scpi);
 408 }
 409
 410 /**
 411  * Get the connection ID of the SCPI device.
 412  *
 413  * @param scpi Previously initialized SCPI device structure.
 414  * @param connection_id Pointer where to store the connection ID. The caller
 415  *        is responsible for g_free()ing the string when it is no longer needed.
 416  *
 417  * @return SR_OK on success, SR_ERR on failure.
 418  */
 419 SR_PRIV int sr_scpi_connection_id(struct sr_scpi_dev_inst *scpi,
 420                 char **connection_id)
 421 {
 422         return scpi->connection_id(scpi, connection_id);
 423 }
 424
 425 /**
 426  * Add an event source for an SCPI device.
 427  *
 428  * @param session The session to add the event source to.
 429  * @param scpi Previously initialized SCPI device structure.
 430  * @param events Events to check for.
 431  * @param timeout Max time to wait before the callback is called, ignored if 0.
 432  * @param cb Callback function to add. Must not be NULL.
 433  * @param cb_data Data for the callback function. Can be NULL.
 434  *
 435  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 436  *         SR_ERR_MALLOC upon memory allocation errors.
 437  */
 438 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
 439                 struct sr_scpi_dev_inst *scpi, int events, int timeout,
 440                 sr_receive_data_callback cb, void *cb_data)
 441 {
 442         return scpi->source_add(session, scpi->priv, events, timeout, cb, cb_data);
 443 }
 444
 445 /**
 446  * Remove event source for an SCPI device.
 447  *
 448  * @param session The session to remove the event source from.
 449  * @param scpi Previously initialized SCPI device structure.
 450  *
 451  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 452  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
 453  *         internal errors.
 454  */
 455 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
 456                 struct sr_scpi_dev_inst *scpi)
 457 {
 458         return scpi->source_remove(session, scpi->priv);
 459 }
 460
 461 /**
 462  * Send a SCPI command.
 463  *
 464  * @param scpi Previously initialized SCPI device structure.
 465  * @param format Format string, to be followed by any necessary arguments.
 466  *
 467  * @return SR_OK on success, SR_ERR on failure.
 468  */
 469 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
 470                          const char *format, ...)
 471 {
 472         va_list args;
 473         int ret;
 474
 475         va_start(args, format);
 476         g_mutex_lock(&scpi->scpi_mutex);
 477         ret = scpi_send_variadic(scpi, format, args);
 478         g_mutex_unlock(&scpi->scpi_mutex);
 479         va_end(args);
 480
 481         return ret;
 482 }
 483
 484 /**
 485  * Send a SCPI command with a variadic argument list.
 486  *
 487  * @param scpi Previously initialized SCPI device structure.
 488  * @param format Format string.
 489  * @param args Argument list.
 490  *
 491  * @return SR_OK on success, SR_ERR on failure.
 492  */
 493 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
 494                          const char *format, va_list args)
 495 {
 496         int ret;
 497
 498         g_mutex_lock(&scpi->scpi_mutex);
 499         ret = scpi_send_variadic(scpi, format, args);
 500         g_mutex_unlock(&scpi->scpi_mutex);
 501
 502         return ret;
 503 }
 504
 505 /**
 506  * Begin receiving an SCPI reply.
 507  *
 508  * @param scpi Previously initialised SCPI device structure.
 509  *
 510  * @return SR_OK on success, SR_ERR on failure.
 511  */
 512 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
 513 {
 514         return scpi->read_begin(scpi->priv);
 515 }
 516
 517 /**
 518  * Read part of a response from SCPI device.
 519  *
 520  * @param scpi Previously initialised SCPI device structure.
 521  * @param buf Buffer to store result.
 522  * @param maxlen Maximum number of bytes to read.
 523  *
 524  * @return Number of bytes read, or SR_ERR upon failure.
 525  */
 526 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
 527                         char *buf, int maxlen)
 528 {
 529         int ret;
 530
 531         g_mutex_lock(&scpi->scpi_mutex);
 532         ret = scpi_read_data(scpi, buf, maxlen);
 533         g_mutex_unlock(&scpi->scpi_mutex);
 534
 535         return ret;
 536 }
 537
 538 /**
 539  * Send data to SCPI device.
 540  *
 541  * TODO: This is only implemented in TcpRaw, but never used.
 542  * TODO: Use Mutex at all?
 543  *
 544  * @param scpi Previously initialised SCPI device structure.
 545  * @param buf Buffer with data to send.
 546  * @param len Number of bytes to send.
 547  *
 548  * @return Number of bytes read, or SR_ERR upon failure.
 549  */
 550 SR_PRIV int sr_scpi_write_data(struct sr_scpi_dev_inst *scpi,
 551                         char *buf, int maxlen)
 552 {
 553         int ret;
 554
 555         g_mutex_lock(&scpi->scpi_mutex);
 556         ret = scpi_write_data(scpi, buf, maxlen);
 557         g_mutex_unlock(&scpi->scpi_mutex);
 558
 559         return ret;
 560 }
 561
 562 /**
 563  * Check whether a complete SCPI response has been received.
 564  *
 565  * @param scpi Previously initialised SCPI device structure.
 566  *
 567  * @return 1 if complete, 0 otherwise.
 568  */
 569 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
 570 {
 571         return scpi->read_complete(scpi->priv);
 572 }
 573
 574 /**
 575  * Close SCPI device.
 576  *
 577  * @param scpi Previously initialized SCPI device structure.
 578  *
 579  * @return SR_OK on success, SR_ERR on failure.
 580  */
 581 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
 582 {
 583         int ret;
 584
 585         g_mutex_lock(&scpi->scpi_mutex);
 586         ret = scpi->close(scpi);
 587         g_mutex_unlock(&scpi->scpi_mutex);
 588         g_mutex_clear(&scpi->scpi_mutex);
 589
 590         return ret;
 591 }
 592
 593 /**
 594  * Free SCPI device.
 595  *
 596  * @param scpi Previously initialized SCPI device structure. If NULL,
 597  *             this function does nothing.
 598  */
 599 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
 600 {
 601         if (!scpi)
 602                 return;
 603
 604         scpi->free(scpi->priv);
 605         g_free(scpi->priv);
 606         g_free(scpi->actual_channel_name);
 607         g_free(scpi);
 608 }
 609
 610 /**
 611  * Send a SCPI command, receive the reply and store the reply in scpi_response.
 612  *
 613  * @param scpi Previously initialised SCPI device structure.
 614  * @param command The SCPI command to send to the device (can be NULL).
 615  * @param scpi_response Pointer where to store the SCPI response.
 616  *
 617  * @return SR_OK on success, SR_ERR* on failure.
 618  */
 619 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
 620                                const char *command, char **scpi_response)
 621 {
 622         GString *response;
 623         response = g_string_sized_new(1024);
 624
 625         if (sr_scpi_get_data(scpi, command, &response) != SR_OK) {
 626                 if (response)
 627                         g_string_free(response, TRUE);
 628                 return SR_ERR;
 629         }
 630
 631         /* Get rid of trailing linefeed if present */
 632         if (response->len >= 1 && response->str[response->len - 1] == '\n')
 633                 g_string_truncate(response, response->len - 1);
 634
 635         /* Get rid of trailing carriage return if present */
 636         if (response->len >= 1 && response->str[response->len - 1] == '\r')
 637                 g_string_truncate(response, response->len - 1);
 638
 639         sr_spew("Got response: '%.70s', length %" G_GSIZE_FORMAT ".",
 640                 response->str, response->len);
 641
 642         *scpi_response = g_string_free(response, FALSE);
 643
 644         return SR_OK;
 645 }
 646
 647 /**
 648  * Do a non-blocking read of up to the allocated length, and
 649  * check if a timeout has occured.
 650  *
 651  * @param scpi Previously initialised SCPI device structure.
 652  * @param response Buffer to which the response is appended.
 653  * @param abs_timeout_us Absolute timeout in microseconds
 654  *
 655  * @return read length on success, SR_ERR* on failure.
 656  */
 657 SR_PRIV int sr_scpi_read_response(struct sr_scpi_dev_inst *scpi,
 658                                   GString *response, gint64 abs_timeout_us)
 659 {
 660         int ret;
 661
 662         g_mutex_lock(&scpi->scpi_mutex);
 663         ret = scpi_read_response(scpi, response, abs_timeout_us);
 664         g_mutex_unlock(&scpi->scpi_mutex);
 665
 666         return ret;
 667 }
 668
 669 SR_PRIV int sr_scpi_get_data(struct sr_scpi_dev_inst *scpi,
 670                              const char *command, GString **scpi_response)
 671 {
 672         int ret;
 673
 674         g_mutex_lock(&scpi->scpi_mutex);
 675         ret = scpi_get_data(scpi, command, scpi_response);
 676         g_mutex_unlock(&scpi->scpi_mutex);
 677
 678         return ret;
 679 }
 680
 681 /**
 682  * Send a SCPI command, read the reply, parse it as a bool value and store the
 683  * result in scpi_response.
 684  *
 685  * @param scpi Previously initialised SCPI device structure.
 686  * @param command The SCPI command to send to the device (can be NULL).
 687  * @param scpi_response Pointer where to store the parsed result.
 688  *
 689  * @return SR_OK on success, SR_ERR* on failure.
 690  */
 691 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
 692                              const char *command, gboolean *scpi_response)
 693 {
 694         int ret;
 695         char *response;
 696
 697         response = NULL;
 698
 699         ret = sr_scpi_get_string(scpi, command, &response);
 700         if (ret != SR_OK && !response)
 701                 return ret;
 702
 703         if (parse_strict_bool(response, scpi_response) == SR_OK)
 704                 ret = SR_OK;
 705         else
 706                 ret = SR_ERR_DATA;
 707
 708         g_free(response);
 709
 710         return ret;
 711 }
 712
 713 /**
 714  * Send a SCPI command, read the reply, parse it as an integer and store the
 715  * result in scpi_response.
 716  *
 717  * @param scpi Previously initialised SCPI device structure.
 718  * @param command The SCPI command to send to the device (can be NULL).
 719  * @param scpi_response Pointer where to store the parsed result.
 720  *
 721  * @return SR_OK on success, SR_ERR* on failure.
 722  */
 723 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
 724                             const char *command, int *scpi_response)
 725 {
 726         int ret;
 727         char *response;
 728
 729         response = NULL;
 730
 731         ret = sr_scpi_get_string(scpi, command, &response);
 732         if (ret != SR_OK && !response)
 733                 return ret;
 734
 735         if (sr_atoi(response, scpi_response) == SR_OK)
 736                 ret = SR_OK;
 737         else
 738                 ret = SR_ERR_DATA;
 739
 740         g_free(response);
 741
 742         return ret;
 743 }
 744
 745 /**
 746  * Send a SCPI command, read the reply, parse it as a float and store the
 747  * result in scpi_response.
 748  *
 749  * @param scpi Previously initialised SCPI device structure.
 750  * @param command The SCPI command to send to the device (can be NULL).
 751  * @param scpi_response Pointer where to store the parsed result.
 752  *
 753  * @return SR_OK on success, SR_ERR* on failure.
 754  */
 755 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
 756                               const char *command, float *scpi_response)
 757 {
 758         int ret;
 759         char *response;
 760
 761         response = NULL;
 762
 763         ret = sr_scpi_get_string(scpi, command, &response);
 764         if (ret != SR_OK && !response)
 765                 return ret;
 766
 767         if (sr_atof_ascii(response, scpi_response) == SR_OK)
 768                 ret = SR_OK;
 769         else
 770                 ret = SR_ERR_DATA;
 771
 772         g_free(response);
 773
 774         return ret;
 775 }
 776
 777 /**
 778  * Send a SCPI command, read the reply, parse it as a double and store the
 779  * result in scpi_response.
 780  *
 781  * @param scpi Previously initialised SCPI device structure.
 782  * @param command The SCPI command to send to the device (can be NULL).
 783  * @param scpi_response Pointer where to store the parsed result.
 784  *
 785  * @return SR_OK on success, SR_ERR* on failure.
 786  */
 787 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
 788                                const char *command, double *scpi_response)
 789 {
 790         int ret;
 791         char *response;
 792
 793         response = NULL;
 794
 795         ret = sr_scpi_get_string(scpi, command, &response);
 796         if (ret != SR_OK && !response)
 797                 return ret;
 798
 799         if (sr_atod_ascii(response, scpi_response) == SR_OK)
 800                 ret = SR_OK;
 801         else
 802                 ret = SR_ERR_DATA;
 803
 804         g_free(response);
 805
 806         return ret;
 807 }
 808
 809 /**
 810  * Send a SCPI *OPC? command, read the reply and return the result of the
 811  * command.
 812  *
 813  * @param scpi Previously initialised SCPI device structure.
 814  *
 815  * @return SR_OK on success, SR_ERR* on failure.
 816  */
 817 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
 818 {
 819         unsigned int i;
 820         gboolean opc;
 821
 822         for (i = 0; i < SCPI_READ_RETRIES; i++) {
 823                 opc = FALSE;
 824                 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
 825                 if (opc)
 826                         return SR_OK;
 827                 g_usleep(SCPI_READ_RETRY_TIMEOUT_US);
 828         }
 829
 830         return SR_ERR;
 831 }
 832
 833 /**
 834  * Send a SCPI command, read the reply, parse it as comma separated list of
 835  * floats and store the as an result in scpi_response.
 836  *
 837  * @param scpi Previously initialised SCPI device structure.
 838  * @param command The SCPI command to send to the device (can be NULL).
 839  * @param scpi_response Pointer where to store the parsed result.
 840  *
 841  * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
 842  *         error or upon no response. The allocated response must be freed by
 843  *         the caller in the case of an SR_OK as well as in the case of
 844  *         parsing error.
 845  */
 846 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
 847                                const char *command, GArray **scpi_response)
 848 {
 849         int ret;
 850         float tmp;
 851         char *response;
 852         gchar **ptr, **tokens;
 853         GArray *response_array;
 854
 855         response = NULL;
 856         tokens = NULL;
 857
 858         ret = sr_scpi_get_string(scpi, command, &response);
 859         if (ret != SR_OK && !response)
 860                 return ret;
 861
 862         tokens = g_strsplit(response, ",", 0);
 863         ptr = tokens;
 864
 865         response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
 866
 867         while (*ptr) {
 868                 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
 869                         response_array = g_array_append_val(response_array,
 870                                                             tmp);
 871                 else
 872                         ret = SR_ERR_DATA;
 873
 874                 ptr++;
 875         }
 876         g_strfreev(tokens);
 877         g_free(response);
 878
 879         if (ret != SR_OK && response_array->len == 0) {
 880                 g_array_free(response_array, TRUE);
 881                 *scpi_response = NULL;
 882                 return SR_ERR_DATA;
 883         }
 884
 885         *scpi_response = response_array;
 886
 887         return ret;
 888 }
 889
 890 /**
 891  * Send a SCPI command, read the reply, parse it as comma separated list of
 892  * unsigned 8 bit integers and store the as an result in scpi_response.
 893  *
 894  * @param scpi Previously initialised SCPI device structure.
 895  * @param command The SCPI command to send to the device (can be NULL).
 896  * @param scpi_response Pointer where to store the parsed result.
 897  *
 898  * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
 899  *         error or upon no response. The allocated response must be freed by
 900  *         the caller in the case of an SR_OK as well as in the case of
 901  *         parsing error.
 902  */
 903 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
 904                                const char *command, GArray **scpi_response)
 905 {
 906         int tmp, ret;
 907         char *response;
 908         gchar **ptr, **tokens;
 909         GArray *response_array;
 910
 911         response = NULL;
 912         tokens = NULL;
 913
 914         ret = sr_scpi_get_string(scpi, command, &response);
 915         if (ret != SR_OK && !response)
 916                 return ret;
 917
 918         tokens = g_strsplit(response, ",", 0);
 919         ptr = tokens;
 920
 921         response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
 922
 923         while (*ptr) {
 924                 if (sr_atoi(*ptr, &tmp) == SR_OK)
 925                         response_array = g_array_append_val(response_array,
 926                                                             tmp);
 927                 else
 928                         ret = SR_ERR_DATA;
 929
 930                 ptr++;
 931         }
 932         g_strfreev(tokens);
 933         g_free(response);
 934
 935         if (response_array->len == 0) {
 936                 g_array_free(response_array, TRUE);
 937                 *scpi_response = NULL;
 938                 return SR_ERR_DATA;
 939         }
 940
 941         *scpi_response = response_array;
 942
 943         return ret;
 944 }
 945
 946 /**
 947  * Send a SCPI command, read the reply, parse it as binary data with a
 948  * "definite length block" header and store the as an result in scpi_response.
 949  *
 950  * @param scpi Previously initialised SCPI device structure.
 951  * @param command The SCPI command to send to the device (can be NULL).
 952  * @param scpi_response Pointer where to store the parsed result.
 953  *
 954  * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
 955  *         error or upon no response. The allocated response must be freed by
 956  *         the caller in the case of an SR_OK as well as in the case of
 957  *         parsing error.
 958  */
 959 SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
 960                                const char *command, GByteArray **scpi_response)
 961 {
 962         int ret;
 963         GString* response;
 964         gsize oldlen;
 965         char buf[10];
 966         long llen;
 967         long datalen;
 968         gint64 timeout;
 969
 970         g_mutex_lock(&scpi->scpi_mutex);
 971
 972         if (command)
 973                 if (scpi_send(scpi, command) != SR_OK) {
 974                         g_mutex_unlock(&scpi->scpi_mutex);
 975                         return SR_ERR;
 976                 }
 977
 978         if (sr_scpi_read_begin(scpi) != SR_OK) {
 979                 g_mutex_unlock(&scpi->scpi_mutex);
 980                 return SR_ERR;
 981         }
 982
 983         /*
 984          * Assume an initial maximum length, optionally gets adjusted below.
 985          * Prepare a NULL return value for when error paths will be taken.
 986          */
 987         response = g_string_sized_new(1024);
 988
 989         timeout = g_get_monotonic_time() + scpi->read_timeout_us;
 990
 991         *scpi_response = NULL;
 992
 993         /* Get (the first chunk of) the response. */
 994         do {
 995                 ret = scpi_read_response(scpi, response, timeout);
 996                 if (ret < 0) {
 997                         g_mutex_unlock(&scpi->scpi_mutex);
 998                         g_string_free(response, TRUE);
 999                         return ret;
1000                 }
1001         } while (response->len < 2);
1002
1003         /*
1004          * SCPI protocol data blocks are preceeded with a length spec.
1005          * The length spec consists of a '#' marker, one digit which
1006          * specifies the character count of the length spec, and the
1007          * respective number of characters which specify the data block's
1008          * length. Raw data bytes follow (thus one must no longer assume
1009          * that the received input stream would be an ASCIIZ string).
1010          *
1011          * Get the data block length, and strip off the length spec from
1012          * the input buffer, leaving just the data bytes.
1013          */
1014         if (response->str[0] != '#') {
1015                 g_mutex_unlock(&scpi->scpi_mutex);
1016                 g_string_free(response, TRUE);
1017                 return SR_ERR_DATA;
1018         }
1019         buf[0] = response->str[1];
1020         buf[1] = '\0';
1021         ret = sr_atol(buf, &llen);
1022         if ((ret != SR_OK) || (llen == 0)) {
1023                 g_mutex_unlock(&scpi->scpi_mutex);
1024                 g_string_free(response, TRUE);
1025                 return ret;
1026         }
1027
1028         while (response->len < (unsigned long)(2 + llen)) {
1029                 ret = scpi_read_response(scpi, response, timeout);
1030                 if (ret < 0) {
1031                         g_mutex_unlock(&scpi->scpi_mutex);
1032                         g_string_free(response, TRUE);
1033                         return ret;
1034                 }
1035         }
1036
1037         memcpy(buf, &response->str[2], llen);
1038         buf[llen] = '\0';
1039         ret = sr_atol(buf, &datalen);
1040         if ((ret != SR_OK) || (datalen == 0)) {
1041                 g_mutex_unlock(&scpi->scpi_mutex);
1042                 g_string_free(response, TRUE);
1043                 return ret;
1044         }
1045         g_string_erase(response, 0, 2 + llen);
1046
1047         /*
1048          * Re-allocate the buffer size to the now known length
1049          * and keep reading more chunks of response data.
1050          */
1051         oldlen = response->len;
1052         g_string_set_size(response, datalen);
1053         g_string_set_size(response, oldlen);
1054
1055         if (oldlen < (unsigned long)(datalen)) {
1056                 do {
1057                         oldlen = response->len;
1058                         ret = scpi_read_response(scpi, response, timeout);
1059
1060                         /* On timeout truncate the buffer and send the partial response
1061                          * instead of getting stuck on timeouts...
1062                          */
1063                         if (ret == SR_ERR_TIMEOUT) {
1064                                 datalen = oldlen;
1065                                 break;
1066                         }
1067                         if (ret < 0) {
1068                                 g_mutex_unlock(&scpi->scpi_mutex);
1069                                 g_string_free(response, TRUE);
1070                                 return ret;
1071                         }
1072                         if (ret > 0)
1073                                 timeout = g_get_monotonic_time() + scpi->read_timeout_us;
1074                 } while (response->len < (unsigned long)(datalen));
1075         }
1076
1077         g_mutex_unlock(&scpi->scpi_mutex);
1078
1079         /* Convert received data to byte array. */
1080         *scpi_response = g_byte_array_new_take(
1081                 (guint8*)g_string_free(response, FALSE), datalen);
1082
1083         return SR_OK;
1084 }
1085
1086 /**
1087  * Send the *IDN? SCPI command, receive the reply, parse it and store the
1088  * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
1089  *
1090  * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
1091  *
1092  * @param scpi Previously initialised SCPI device structure.
1093  * @param scpi_response Pointer where to store the hw_info structure.
1094  *
1095  * @return SR_OK upon success, SR_ERR* on failure.
1096  */
1097 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
1098                               struct sr_scpi_hw_info **scpi_response)
1099 {
1100         int num_tokens, ret;
1101         char *response;
1102         gchar **tokens;
1103         struct sr_scpi_hw_info *hw_info;
1104         gchar *idn_substr;
1105
1106         response = NULL;
1107         tokens = NULL;
1108
1109         ret = sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response);
1110         if (ret != SR_OK && !response)
1111                 return ret;
1112
1113         /*
1114          * The response to a '*IDN?' is specified by the SCPI spec. It contains
1115          * a comma-separated list containing the manufacturer name, instrument
1116          * model, serial number of the instrument and the firmware version.
1117          */
1118         tokens = g_strsplit(response, ",", 0);
1119         num_tokens = g_strv_length(tokens);
1120         if (num_tokens < 4) {
1121                 sr_dbg("IDN response not according to spec: %80.s.", response);
1122                 g_strfreev(tokens);
1123                 g_free(response);
1124                 return SR_ERR_DATA;
1125         }
1126         g_free(response);
1127
1128         hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info));
1129
1130         idn_substr = g_strstr_len(tokens[0], -1, "IDN ");
1131         if (idn_substr == NULL)
1132                 hw_info->manufacturer = g_strstrip(g_strdup(tokens[0]));
1133         else
1134                 hw_info->manufacturer = g_strstrip(g_strdup(idn_substr + 4));
1135
1136         hw_info->model = g_strstrip(g_strdup(tokens[1]));
1137         hw_info->serial_number = g_strstrip(g_strdup(tokens[2]));
1138         hw_info->firmware_version = g_strstrip(g_strdup(tokens[3]));
1139
1140         g_strfreev(tokens);
1141
1142         *scpi_response = hw_info;
1143
1144         return SR_OK;
1145 }
1146
1147 /**
1148  * Free a sr_scpi_hw_info struct.
1149  *
1150  * @param hw_info Pointer to the struct to free. If NULL, this
1151  *                function does nothing.
1152  */
1153 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
1154 {
1155         if (!hw_info)
1156                 return;
1157
1158         g_free(hw_info->manufacturer);
1159         g_free(hw_info->model);
1160         g_free(hw_info->serial_number);
1161         g_free(hw_info->firmware_version);
1162         g_free(hw_info);
1163 }
1164
1165 /**
1166  * Remove potentially enclosing pairs of quotes, un-escape content.
1167  * This implementation modifies the caller's buffer when quotes are found
1168  * and doubled quote characters need to get removed from the content.
1169  *
1170  * @param[in, out] s    The SCPI string to check and un-quote.
1171  *
1172  * @return The start of the un-quoted string.
1173  */
1174 SR_PRIV const char *sr_scpi_unquote_string(char *s)
1175 {
1176         size_t s_len;
1177         char quotes[3];
1178         char *rdptr;
1179
1180         /* Immediately bail out on invalid or short input. */
1181         if (!s || !*s)
1182                 return s;
1183         s_len = strlen(s);
1184         if (s_len < 2)
1185                 return s;
1186
1187         /* Check for matching quote characters front and back. */
1188         if (s[0] != '\'' && s[0] != '"')
1189                 return s;
1190         if (s[0] != s[s_len - 1])
1191                 return s;
1192
1193         /* Need to strip quotes, and un-double quote chars inside. */
1194         quotes[0] = quotes[1] = *s;
1195         quotes[2] = '\0';
1196         s[s_len - 1] = '\0';
1197         s++;
1198         rdptr = s;
1199         while ((rdptr = strstr(rdptr, quotes)) != NULL) {
1200                 memmove(rdptr, rdptr + 1, strlen(rdptr));
1201                 rdptr++;
1202         }
1203
1204         return s;
1205 }
1206
1207 SR_PRIV const char *sr_vendor_alias(const char *raw_vendor)
1208 {
1209         unsigned int i;
1210
1211         for (i = 0; i < ARRAY_SIZE(scpi_vendors); i++) {
1212                 if (!g_ascii_strcasecmp(raw_vendor, scpi_vendors[i][0]))
1213                         return scpi_vendors[i][1];
1214         }
1215
1216         return raw_vendor;
1217 }
1218
1219 SR_PRIV const char *sr_scpi_cmd_get(const struct scpi_command *cmdtable,
1220                 int command)
1221 {
1222         unsigned int i;
1223         const char *cmd;
1224
1225         if (!cmdtable)
1226                 return NULL;
1227
1228         cmd = NULL;
1229         for (i = 0; cmdtable[i].string; i++) {
1230                 if (cmdtable[i].command == command) {
1231                         cmd = cmdtable[i].string;
1232                         break;
1233                 }
1234         }
1235
1236         return cmd;
1237 }
1238
1239 SR_PRIV int sr_scpi_cmd(const struct sr_dev_inst *sdi,
1240                 const struct scpi_command *cmdtable,
1241                 int channel_command, const char *channel_name,
1242                 int command, ...)
1243 {
1244         struct sr_scpi_dev_inst *scpi;
1245         va_list args;
1246         int ret;
1247         const char *channel_cmd;
1248         const char *cmd;
1249
1250         scpi = sdi->conn;
1251
1252         if (!(cmd = sr_scpi_cmd_get(cmdtable, command))) {
1253                 /* Device does not implement this command, that's OK. */
1254                 return SR_OK;
1255         }
1256
1257         g_mutex_lock(&scpi->scpi_mutex);
1258
1259         /* Select channel. */
1260         channel_cmd = sr_scpi_cmd_get(cmdtable, channel_command);
1261         if (channel_cmd && channel_name &&
1262                         g_strcmp0(channel_name, scpi->actual_channel_name)) {
1263                 sr_spew("sr_scpi_cmd(): new channel = %s", channel_name);
1264                 g_free(scpi->actual_channel_name);
1265                 scpi->actual_channel_name = g_strdup(channel_name);
1266                 ret = scpi_send(scpi, channel_cmd, channel_name);
1267                 if (ret != SR_OK)
1268                         return ret;
1269         }
1270
1271         va_start(args, command);
1272         ret = scpi_send_variadic(scpi, cmd, args);
1273         va_end(args);
1274
1275         g_mutex_unlock(&scpi->scpi_mutex);
1276
1277         return ret;
1278 }
1279
1280 SR_PRIV int sr_scpi_cmd_resp(const struct sr_dev_inst *sdi,
1281                 const struct scpi_command *cmdtable,
1282                 int channel_command, const char *channel_name,
1283                 GVariant **gvar, const GVariantType *gvtype, int command, ...)
1284 {
1285         struct sr_scpi_dev_inst *scpi;
1286         va_list args;
1287         const char *channel_cmd;
1288         const char *cmd;
1289         GString *response;
1290         char *s;
1291         gboolean b;
1292         double d;
1293         int ret;
1294
1295         scpi = sdi->conn;
1296
1297         if (!(cmd = sr_scpi_cmd_get(cmdtable, command))) {
1298                 /* Device does not implement this command. */
1299                 return SR_ERR_NA;
1300         }
1301
1302         g_mutex_lock(&scpi->scpi_mutex);
1303
1304         /* Select channel. */
1305         channel_cmd = sr_scpi_cmd_get(cmdtable, channel_command);
1306         if (channel_cmd && channel_name &&
1307                         g_strcmp0(channel_name, scpi->actual_channel_name)) {
1308                 sr_spew("sr_scpi_cmd_get(): new channel = %s", channel_name);
1309                 g_free(scpi->actual_channel_name);
1310                 scpi->actual_channel_name = g_strdup(channel_name);
1311                 ret = scpi_send(scpi, channel_cmd, channel_name);
1312                 if (ret != SR_OK)
1313                         return ret;
1314         }
1315
1316         va_start(args, command);
1317         ret = scpi_send_variadic(scpi, cmd, args);
1318         va_end(args);
1319         if (ret != SR_OK) {
1320                 g_mutex_unlock(&scpi->scpi_mutex);
1321                 return ret;
1322         }
1323
1324         response = g_string_sized_new(1024);
1325         ret = scpi_get_data(scpi, NULL, &response);
1326         if (ret != SR_OK) {
1327                 g_mutex_unlock(&scpi->scpi_mutex);
1328                 if (response)
1329                         g_string_free(response, TRUE);
1330                 return ret;
1331         }
1332
1333         g_mutex_unlock(&scpi->scpi_mutex);
1334
1335         /* Get rid of trailing linefeed if present */
1336         if (response->len >= 1 && response->str[response->len - 1] == '\n')
1337                 g_string_truncate(response, response->len - 1);
1338
1339         /* Get rid of trailing carriage return if present */
1340         if (response->len >= 1 && response->str[response->len - 1] == '\r')
1341                 g_string_truncate(response, response->len - 1);
1342
1343         s = g_string_free(response, FALSE);
1344
1345         ret = SR_OK;
1346         if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_BOOLEAN)) {
1347                 if ((ret = parse_strict_bool(s, &b)) == SR_OK)
1348                         *gvar = g_variant_new_boolean(b);
1349         } else if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_DOUBLE)) {
1350                 if ((ret = sr_atod_ascii(s, &d)) == SR_OK)
1351                         *gvar = g_variant_new_double(d);
1352         } else if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_STRING)) {
1353                 *gvar = g_variant_new_string(s);
1354         } else {
1355                 sr_err("Unable to convert to desired GVariant type.");
1356                 ret = SR_ERR_NA;
1357         }
1358
1359         g_free(s);
1360
1361         return ret;
1362 }