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