src/scpi/scpi.c

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