hardware/common/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 "libsigrok.h"
  21 #include "libsigrok-internal.h"
  22
  23 #include <glib.h>
  24 #include <string.h>
  25
  26 #define LOG_PREFIX "scpi"
  27
  28 #define SCPI_READ_RETRIES 100
  29 #define SCPI_READ_RETRY_TIMEOUT 10000
  30
  31 /**
  32  * Parse a string representation of a boolean-like value into a gboolean.
  33  * Similar to sr_parse_boolstring but rejects strings which do not represent
  34  * a boolean-like value.
  35  *
  36  * @param str String to convert.
  37  * @param ret Pointer to a gboolean where the result of the conversion will be
  38  * stored.
  39  *
  40  * @return SR_OK on success, SR_ERR on failure.
  41  */
  42 static int parse_strict_bool(const char *str, gboolean *ret)
  43 {
  44         if (!str)
  45                 return SR_ERR_ARG;
  46
  47         if (!g_strcmp0(str, "1") ||
  48             !g_ascii_strncasecmp(str, "y", 1) ||
  49             !g_ascii_strncasecmp(str, "t", 1) ||
  50             !g_ascii_strncasecmp(str, "yes", 3) ||
  51             !g_ascii_strncasecmp(str, "true", 4) ||
  52             !g_ascii_strncasecmp(str, "on", 2)) {
  53                 *ret = TRUE;
  54                 return SR_OK;
  55         } else if (!g_strcmp0(str, "0") ||
  56                    !g_ascii_strncasecmp(str, "n", 1) ||
  57                    !g_ascii_strncasecmp(str, "f", 1) ||
  58                    !g_ascii_strncasecmp(str, "no", 2) ||
  59                    !g_ascii_strncasecmp(str, "false", 5) ||
  60                    !g_ascii_strncasecmp(str, "off", 3)) {
  61                 *ret = FALSE;
  62                 return SR_OK;
  63         }
  64
  65         return SR_ERR;
  66 }
  67
  68 SR_PRIV extern const struct sr_scpi_dev_inst scpi_serial_dev;
  69 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_raw_dev;
  70 SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_rigol_dev;
  71 SR_PRIV extern const struct sr_scpi_dev_inst scpi_usbtmc_dev;
  72 SR_PRIV extern const struct sr_scpi_dev_inst scpi_vxi_dev;
  73
  74 static const struct sr_scpi_dev_inst *scpi_devs[] = {
  75         &scpi_tcp_raw_dev,
  76         &scpi_tcp_rigol_dev,
  77         &scpi_usbtmc_dev,
  78 #if HAVE_RPC
  79         &scpi_vxi_dev,
  80 #endif
  81 #ifdef HAVE_LIBSERIALPORT
  82         &scpi_serial_dev,  /* must be last as it matches any resource */
  83 #endif
  84 };
  85
  86 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(const char *resource,
  87                 const char *serialcomm)
  88 {
  89         struct sr_scpi_dev_inst *scpi = NULL;
  90         const struct sr_scpi_dev_inst *scpi_dev;
  91         gchar **params;
  92         unsigned i;
  93
  94         for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
  95                 scpi_dev = scpi_devs[i];
  96                 if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) {
  97                         sr_dbg("Opening %s device %s.", scpi_dev->name, resource);
  98                         scpi = g_malloc(sizeof(*scpi));
  99                         *scpi = *scpi_dev;
 100                         scpi->priv = g_malloc0(scpi->priv_size);
 101                         params = g_strsplit(resource, "/", 0);
 102                         if (scpi->dev_inst_new(scpi->priv, resource,
 103                                                params, serialcomm) != SR_OK) {
 104                                 sr_scpi_free(scpi);
 105                                 scpi = NULL;
 106                         }
 107                         g_strfreev(params);
 108                         break;
 109                 }
 110         }
 111
 112         return scpi;
 113 }
 114
 115 /**
 116  * Open SCPI device.
 117  *
 118  * @param scpi Previously initialized SCPI device structure.
 119  *
 120  * @return SR_OK on success, SR_ERR on failure.
 121  */
 122 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
 123 {
 124         return scpi->open(scpi->priv);
 125 }
 126
 127 /**
 128  * Add an event source for an SCPI device.
 129  *
 130  * @param scpi Previously initialized SCPI device structure.
 131  * @param events Events to check for.
 132  * @param timeout Max time to wait before the callback is called, ignored if 0.
 133  * @param cb Callback function to add. Must not be NULL.
 134  * @param cb_data Data for the callback function. Can be NULL.
 135  *
 136  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 137  *         SR_ERR_MALLOC upon memory allocation errors.
 138  */
 139 SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
 140                 int timeout, sr_receive_data_callback_t cb, void *cb_data)
 141 {
 142         return scpi->source_add(scpi->priv, events, timeout, cb, cb_data);
 143 }
 144
 145 /**
 146  * Remove event source for an SCPI device.
 147  *
 148  * @param scpi Previously initialized SCPI device structure.
 149  *
 150  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 151  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
 152  *         internal errors.
 153  */
 154 SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi)
 155 {
 156         return scpi->source_remove(scpi->priv);
 157 }
 158
 159 /**
 160  * Send a SCPI command.
 161  *
 162  * @param scpi Previously initialized SCPI device structure.
 163  * @param format Format string, to be followed by any necessary arguments.
 164  *
 165  * @return SR_OK on success, SR_ERR on failure.
 166  */
 167 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
 168                          const char *format, ...)
 169 {
 170         va_list args;
 171         int ret;
 172
 173         va_start(args, format);
 174         ret = sr_scpi_send_variadic(scpi, format, args);
 175         va_end(args);
 176
 177         return ret;
 178 }
 179
 180 /**
 181  * Send a SCPI command with a variadic argument list.
 182  *
 183  * @param scpi Previously initialized SCPI device structure.
 184  * @param format Format string.
 185  * @param args Argument list.
 186  *
 187  * @return SR_OK on success, SR_ERR on failure.
 188  */
 189 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
 190                          const char *format, va_list args)
 191 {
 192         va_list args_copy;
 193         char *buf;
 194         int len, ret;
 195
 196         /* Get length of buffer required. */
 197         va_copy(args_copy, args);
 198         len = vsnprintf(NULL, 0, format, args_copy);
 199         va_end(args_copy);
 200
 201         /* Allocate buffer and write out command. */
 202         buf = g_malloc(len + 1);
 203         vsprintf(buf, format, args);
 204
 205         /* Send command. */
 206         ret = scpi->send(scpi->priv, buf);
 207
 208         /* Free command buffer. */
 209         g_free(buf);
 210
 211         return ret;
 212 }
 213
 214 /**
 215  * Begin receiving an SCPI reply.
 216  *
 217  * @param scpi Previously initialised SCPI device structure.
 218  *
 219  * @return SR_OK on success, SR_ERR on failure.
 220  */
 221 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
 222 {
 223         return scpi->read_begin(scpi->priv);
 224 }
 225
 226 /**
 227  * Read part of a response from SCPI device.
 228  *
 229  * @param scpi Previously initialised SCPI device structure.
 230  * @param buf Buffer to store result.
 231  * @param maxlen Maximum number of bytes to read.
 232  *
 233  * @return Number of bytes read, or SR_ERR upon failure.
 234  */
 235 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
 236                         char *buf, int maxlen)
 237 {
 238         return scpi->read_data(scpi->priv, buf, maxlen);
 239 }
 240
 241 /**
 242  * Check whether a complete SCPI response has been received.
 243  *
 244  * @param scpi Previously initialised SCPI device structure.
 245  *
 246  * @return 1 if complete, 0 otherwise.
 247  */
 248 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
 249 {
 250         return scpi->read_complete(scpi->priv);
 251 }
 252
 253 /**
 254  * Close SCPI device.
 255  *
 256  * @param scpi Previously initialized SCPI device structure.
 257  *
 258  * @return SR_OK on success, SR_ERR on failure.
 259  */
 260 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
 261 {
 262         return scpi->close(scpi->priv);
 263 }
 264
 265 /**
 266  * Free SCPI device.
 267  *
 268  * @param scpi Previously initialized SCPI device structure.
 269  *
 270  * @return SR_OK on success, SR_ERR on failure.
 271  */
 272 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
 273 {
 274         scpi->free(scpi->priv);
 275         g_free(scpi->priv);
 276         g_free(scpi);
 277 }
 278
 279 /**
 280  * Send a SCPI command, receive the reply and store the reply in scpi_response.
 281  *
 282  * @param scpi Previously initialised SCPI device structure.
 283  * @param command The SCPI command to send to the device (can be NULL).
 284  * @param scpi_response Pointer where to store the SCPI response.
 285  *
 286  * @return SR_OK on success, SR_ERR on failure.
 287  */
 288 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
 289                                const char *command, char **scpi_response)
 290 {
 291         char buf[256];
 292         int len;
 293         GString *response;
 294
 295         if (command)
 296                 if (sr_scpi_send(scpi, command) != SR_OK)
 297                         return SR_ERR;
 298
 299         if (sr_scpi_read_begin(scpi) != SR_OK)
 300                 return SR_ERR;
 301
 302         response = g_string_new("");
 303
 304         *scpi_response = NULL;
 305
 306         while (!sr_scpi_read_complete(scpi)) {
 307                 len = sr_scpi_read_data(scpi, buf, sizeof(buf));
 308                 if (len < 0) {
 309                         g_string_free(response, TRUE);
 310                         return SR_ERR;
 311                 }
 312                 g_string_append_len(response, buf, len);
 313         }
 314
 315         *scpi_response = response->str;
 316         g_string_free(response, FALSE);
 317
 318         return SR_OK;
 319 }
 320
 321 /**
 322  * Send a SCPI command, read the reply, parse it as a bool value and store the
 323  * result in scpi_response.
 324  *
 325  * @param scpi Previously initialised SCPI device structure.
 326  * @param command The SCPI command to send to the device (can be NULL).
 327  * @param scpi_response Pointer where to store the parsed result.
 328  *
 329  * @return SR_OK on success, SR_ERR on failure.
 330  */
 331 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
 332                              const char *command, gboolean *scpi_response)
 333 {
 334         int ret;
 335         char *response;
 336
 337         response = NULL;
 338
 339         if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
 340                 if (!response)
 341                         return SR_ERR;
 342
 343         if (parse_strict_bool(response, scpi_response) == SR_OK)
 344                 ret = SR_OK;
 345         else
 346                 ret = SR_ERR;
 347
 348         g_free(response);
 349
 350         return ret;
 351 }
 352
 353 /**
 354  * Send a SCPI command, read the reply, parse it as an integer and store the
 355  * result in scpi_response.
 356  *
 357  * @param scpi Previously initialised SCPI device structure.
 358  * @param command The SCPI command to send to the device (can be NULL).
 359  * @param scpi_response Pointer where to store the parsed result.
 360  *
 361  * @return SR_OK on success, SR_ERR on failure.
 362  */
 363 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
 364                             const char *command, int *scpi_response)
 365 {
 366         int ret;
 367         char *response;
 368
 369         response = NULL;
 370
 371         if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
 372                 if (!response)
 373                         return SR_ERR;
 374
 375         if (sr_atoi(response, scpi_response) == SR_OK)
 376                 ret = SR_OK;
 377         else
 378                 ret = SR_ERR;
 379
 380         g_free(response);
 381
 382         return ret;
 383 }
 384
 385 /**
 386  * Send a SCPI command, read the reply, parse it as a float and store the
 387  * result in scpi_response.
 388  *
 389  * @param scpi Previously initialised SCPI device structure.
 390  * @param command The SCPI command to send to the device (can be NULL).
 391  * @param scpi_response Pointer where to store the parsed result.
 392  *
 393  * @return SR_OK on success, SR_ERR on failure.
 394  */
 395 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
 396                               const char *command, float *scpi_response)
 397 {
 398         int ret;
 399         char *response;
 400
 401         response = NULL;
 402
 403         if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
 404                 if (!response)
 405                         return SR_ERR;
 406
 407         if (sr_atof_ascii(response, scpi_response) == SR_OK)
 408                 ret = SR_OK;
 409         else
 410                 ret = SR_ERR;
 411
 412         g_free(response);
 413
 414         return ret;
 415 }
 416
 417 /**
 418  * Send a SCPI command, read the reply, parse it as a double and store the
 419  * result in scpi_response.
 420  *
 421  * @param scpi Previously initialised SCPI device structure.
 422  * @param command The SCPI command to send to the device (can be NULL).
 423  * @param scpi_response Pointer where to store the parsed result.
 424  *
 425  * @return SR_OK on success, SR_ERR on failure.
 426  */
 427 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
 428                                const char *command, double *scpi_response)
 429 {
 430         int ret;
 431         char *response;
 432
 433         response = NULL;
 434
 435         if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
 436                 if (!response)
 437                         return SR_ERR;
 438
 439         if (sr_atod(response, scpi_response) == SR_OK)
 440                 ret = SR_OK;
 441         else
 442                 ret = SR_ERR;
 443
 444         g_free(response);
 445
 446         return ret;
 447 }
 448
 449 /**
 450  * Send a SCPI *OPC? command, read the reply and return the result of the
 451  * command.
 452  *
 453  * @param scpi Previously initialised SCPI device structure.
 454  *
 455  * @return SR_OK on success, SR_ERR on failure.
 456  */
 457 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
 458 {
 459         unsigned int i;
 460         gboolean opc;
 461
 462         for (i = 0; i < SCPI_READ_RETRIES; ++i) {
 463                 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
 464                 if (opc)
 465                         return SR_OK;
 466                 g_usleep(SCPI_READ_RETRY_TIMEOUT);
 467         }
 468
 469         return SR_ERR;
 470 }
 471
 472 /**
 473  * Send a SCPI command, read the reply, parse it as comma separated list of
 474  * floats and store the as an result in scpi_response.
 475  *
 476  * @param scpi Previously initialised SCPI device structure.
 477  * @param command The SCPI command to send to the device (can be NULL).
 478  * @param scpi_response Pointer where to store the parsed result.
 479  *
 480  * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
 481  *         error or upon no response. The allocated response must be freed by
 482  *         the caller in the case of an SR_OK as well as in the case of
 483  *         parsing error.
 484  */
 485 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
 486                                const char *command, GArray **scpi_response)
 487 {
 488         int ret;
 489         float tmp;
 490         char *response;
 491         gchar **ptr, **tokens;
 492         GArray *response_array;
 493
 494         ret = SR_OK;
 495         response = NULL;
 496         tokens = NULL;
 497
 498         if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
 499                 if (!response)
 500                         return SR_ERR;
 501
 502         tokens = g_strsplit(response, ",", 0);
 503         ptr = tokens;
 504
 505         response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
 506
 507         while (*ptr) {
 508                 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
 509                         response_array = g_array_append_val(response_array,
 510                                                             tmp);
 511                 else
 512                         ret = SR_ERR;
 513
 514                 ptr++;
 515         }
 516         g_strfreev(tokens);
 517         g_free(response);
 518
 519         if (ret == SR_ERR && response_array->len == 0) {
 520                 g_array_free(response_array, TRUE);
 521                 *scpi_response = NULL;
 522                 return SR_ERR;
 523         }
 524
 525         *scpi_response = response_array;
 526
 527         return ret;
 528 }
 529
 530 /**
 531  * Send a SCPI command, read the reply, parse it as comma separated list of
 532  * unsigned 8 bit integers and store the as an result in scpi_response.
 533  *
 534  * @param scpi Previously initialised SCPI device structure.
 535  * @param command The SCPI command to send to the device (can be NULL).
 536  * @param scpi_response Pointer where to store the parsed result.
 537  *
 538  * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
 539  *         error or upon no response. The allocated response must be freed by
 540  *         the caller in the case of an SR_OK as well as in the case of
 541  *         parsing error.
 542  */
 543 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
 544                                const char *command, GArray **scpi_response)
 545 {
 546         int tmp, ret;
 547         char *response;
 548         gchar **ptr, **tokens;
 549         GArray *response_array;
 550
 551         ret = SR_OK;
 552         response = NULL;
 553         tokens = NULL;
 554
 555         if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
 556                 if (!response)
 557                         return SR_ERR;
 558
 559         tokens = g_strsplit(response, ",", 0);
 560         ptr = tokens;
 561
 562         response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
 563
 564         while (*ptr) {
 565                 if (sr_atoi(*ptr, &tmp) == SR_OK)
 566                         response_array = g_array_append_val(response_array,
 567                                                             tmp);
 568                 else
 569                         ret = SR_ERR;
 570
 571                 ptr++;
 572         }
 573         g_strfreev(tokens);
 574         g_free(response);
 575
 576         if (response_array->len == 0) {
 577                 g_array_free(response_array, TRUE);
 578                 *scpi_response = NULL;
 579                 return SR_ERR;
 580         }
 581
 582         *scpi_response = response_array;
 583
 584         return ret;
 585 }
 586
 587 /**
 588  * Send the *IDN? SCPI command, receive the reply, parse it and store the
 589  * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
 590  *
 591  * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
 592  *
 593  * @param scpi Previously initialised SCPI device structure.
 594  * @param scpi_response Pointer where to store the hw_info structure.
 595  *
 596  * @return SR_OK upon success, SR_ERR on failure.
 597  */
 598 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
 599                               struct sr_scpi_hw_info **scpi_response)
 600 {
 601         int num_tokens;
 602         char *response;
 603         char *newline;
 604         gchar **tokens;
 605         struct sr_scpi_hw_info *hw_info;
 606
 607         response = NULL;
 608         tokens = NULL;
 609
 610         if (sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response) != SR_OK)
 611                 if (!response)
 612                         return SR_ERR;
 613
 614         sr_info("Got IDN string: '%s'", response);
 615
 616         /* Remove trailing newline if present. */
 617         if ((newline = g_strrstr(response, "\n")))
 618                 newline[0] = '\0';
 619
 620         /*
 621          * The response to a '*IDN?' is specified by the SCPI spec. It contains
 622          * a comma-separated list containing the manufacturer name, instrument
 623          * model, serial number of the instrument and the firmware version.
 624          */
 625         tokens = g_strsplit(response, ",", 0);
 626
 627         for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
 628
 629         if (num_tokens != 4) {
 630                 sr_dbg("IDN response not according to spec: %80.s.", response);
 631                 g_strfreev(tokens);
 632                 g_free(response);
 633                 return SR_ERR;
 634         }
 635         g_free(response);
 636
 637         hw_info = g_try_malloc(sizeof(struct sr_scpi_hw_info));
 638         if (!hw_info) {
 639                 g_strfreev(tokens);
 640                 return SR_ERR_MALLOC;
 641         }
 642
 643         hw_info->manufacturer = g_strdup(tokens[0]);
 644         hw_info->model = g_strdup(tokens[1]);
 645         hw_info->serial_number = g_strdup(tokens[2]);
 646         hw_info->firmware_version = g_strdup(tokens[3]);
 647
 648         g_strfreev(tokens);
 649
 650         *scpi_response = hw_info;
 651
 652         return SR_OK;
 653 }
 654
 655 /**
 656  * Free a sr_scpi_hw_info struct.
 657  *
 658  * @param hw_info Pointer to the struct to free.
 659  *
 660  * This function is safe to call with a NULL pointer.
 661  */
 662 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
 663 {
 664         if (hw_info) {
 665                 g_free(hw_info->manufacturer);
 666                 g_free(hw_info->model);
 667                 g_free(hw_info->serial_number);
 668                 g_free(hw_info->firmware_version);
 669                 g_free(hw_info);
 670         }
 671 }