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