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         /* Get rid of trailing linefeed if present */
 316         if (response->len >= 1 && response->str[response->len - 1] == '\n')
 317                 g_string_truncate(response, response->len - 1);
 318
 319         *scpi_response = response->str;
 320         g_string_free(response, FALSE);
 321
 322         sr_spew("Got response: '%s'.", *scpi_response);
 323
 324         return SR_OK;
 325 }
 326
 327 /**
 328  * Send a SCPI command, read the reply, parse it as a bool value and store the
 329  * result in scpi_response.
 330  *
 331  * @param scpi Previously initialised SCPI device structure.
 332  * @param command The SCPI command to send to the device (can be NULL).
 333  * @param scpi_response Pointer where to store the parsed result.
 334  *
 335  * @return SR_OK on success, SR_ERR on failure.
 336  */
 337 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
 338                              const char *command, gboolean *scpi_response)
 339 {
 340         int ret;
 341         char *response;
 342
 343         response = NULL;
 344
 345         if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
 346                 if (!response)
 347                         return SR_ERR;
 348
 349         if (parse_strict_bool(response, scpi_response) == SR_OK)
 350                 ret = SR_OK;
 351         else
 352                 ret = SR_ERR;
 353
 354         g_free(response);
 355
 356         return ret;
 357 }
 358
 359 /**
 360  * Send a SCPI command, read the reply, parse it as an integer and store the
 361  * result in scpi_response.
 362  *
 363  * @param scpi Previously initialised SCPI device structure.
 364  * @param command The SCPI command to send to the device (can be NULL).
 365  * @param scpi_response Pointer where to store the parsed result.
 366  *
 367  * @return SR_OK on success, SR_ERR on failure.
 368  */
 369 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
 370                             const char *command, int *scpi_response)
 371 {
 372         int ret;
 373         char *response;
 374
 375         response = NULL;
 376
 377         if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
 378                 if (!response)
 379                         return SR_ERR;
 380
 381         if (sr_atoi(response, scpi_response) == SR_OK)
 382                 ret = SR_OK;
 383         else
 384                 ret = SR_ERR;
 385
 386         g_free(response);
 387
 388         return ret;
 389 }
 390
 391 /**
 392  * Send a SCPI command, read the reply, parse it as a float and store the
 393  * result in scpi_response.
 394  *
 395  * @param scpi Previously initialised SCPI device structure.
 396  * @param command The SCPI command to send to the device (can be NULL).
 397  * @param scpi_response Pointer where to store the parsed result.
 398  *
 399  * @return SR_OK on success, SR_ERR on failure.
 400  */
 401 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
 402                               const char *command, float *scpi_response)
 403 {
 404         int ret;
 405         char *response;
 406
 407         response = NULL;
 408
 409         if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
 410                 if (!response)
 411                         return SR_ERR;
 412
 413         if (sr_atof_ascii(response, scpi_response) == SR_OK)
 414                 ret = SR_OK;
 415         else
 416                 ret = SR_ERR;
 417
 418         g_free(response);
 419
 420         return ret;
 421 }
 422
 423 /**
 424  * Send a SCPI command, read the reply, parse it as a double and store the
 425  * result in scpi_response.
 426  *
 427  * @param scpi Previously initialised SCPI device structure.
 428  * @param command The SCPI command to send to the device (can be NULL).
 429  * @param scpi_response Pointer where to store the parsed result.
 430  *
 431  * @return SR_OK on success, SR_ERR on failure.
 432  */
 433 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
 434                                const char *command, double *scpi_response)
 435 {
 436         int ret;
 437         char *response;
 438
 439         response = NULL;
 440
 441         if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
 442                 if (!response)
 443                         return SR_ERR;
 444
 445         if (sr_atod(response, scpi_response) == SR_OK)
 446                 ret = SR_OK;
 447         else
 448                 ret = SR_ERR;
 449
 450         g_free(response);
 451
 452         return ret;
 453 }
 454
 455 /**
 456  * Send a SCPI *OPC? command, read the reply and return the result of the
 457  * command.
 458  *
 459  * @param scpi Previously initialised SCPI device structure.
 460  *
 461  * @return SR_OK on success, SR_ERR on failure.
 462  */
 463 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
 464 {
 465         unsigned int i;
 466         gboolean opc;
 467
 468         for (i = 0; i < SCPI_READ_RETRIES; ++i) {
 469                 sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
 470                 if (opc)
 471                         return SR_OK;
 472                 g_usleep(SCPI_READ_RETRY_TIMEOUT);
 473         }
 474
 475         return SR_ERR;
 476 }
 477
 478 /**
 479  * Send a SCPI command, read the reply, parse it as comma separated list of
 480  * floats and store the as an result in scpi_response.
 481  *
 482  * @param scpi Previously initialised SCPI device structure.
 483  * @param command The SCPI command to send to the device (can be NULL).
 484  * @param scpi_response Pointer where to store the parsed result.
 485  *
 486  * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
 487  *         error or upon no response. The allocated response must be freed by
 488  *         the caller in the case of an SR_OK as well as in the case of
 489  *         parsing error.
 490  */
 491 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
 492                                const char *command, GArray **scpi_response)
 493 {
 494         int ret;
 495         float tmp;
 496         char *response;
 497         gchar **ptr, **tokens;
 498         GArray *response_array;
 499
 500         ret = SR_OK;
 501         response = NULL;
 502         tokens = NULL;
 503
 504         if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
 505                 if (!response)
 506                         return SR_ERR;
 507
 508         tokens = g_strsplit(response, ",", 0);
 509         ptr = tokens;
 510
 511         response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
 512
 513         while (*ptr) {
 514                 if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
 515                         response_array = g_array_append_val(response_array,
 516                                                             tmp);
 517                 else
 518                         ret = SR_ERR;
 519
 520                 ptr++;
 521         }
 522         g_strfreev(tokens);
 523         g_free(response);
 524
 525         if (ret == SR_ERR && response_array->len == 0) {
 526                 g_array_free(response_array, TRUE);
 527                 *scpi_response = NULL;
 528                 return SR_ERR;
 529         }
 530
 531         *scpi_response = response_array;
 532
 533         return ret;
 534 }
 535
 536 /**
 537  * Send a SCPI command, read the reply, parse it as comma separated list of
 538  * unsigned 8 bit integers and store the as an result in scpi_response.
 539  *
 540  * @param scpi Previously initialised SCPI device structure.
 541  * @param command The SCPI command to send to the device (can be NULL).
 542  * @param scpi_response Pointer where to store the parsed result.
 543  *
 544  * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
 545  *         error or upon no response. The allocated response must be freed by
 546  *         the caller in the case of an SR_OK as well as in the case of
 547  *         parsing error.
 548  */
 549 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
 550                                const char *command, GArray **scpi_response)
 551 {
 552         int tmp, ret;
 553         char *response;
 554         gchar **ptr, **tokens;
 555         GArray *response_array;
 556
 557         ret = SR_OK;
 558         response = NULL;
 559         tokens = NULL;
 560
 561         if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
 562                 if (!response)
 563                         return SR_ERR;
 564
 565         tokens = g_strsplit(response, ",", 0);
 566         ptr = tokens;
 567
 568         response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
 569
 570         while (*ptr) {
 571                 if (sr_atoi(*ptr, &tmp) == SR_OK)
 572                         response_array = g_array_append_val(response_array,
 573                                                             tmp);
 574                 else
 575                         ret = SR_ERR;
 576
 577                 ptr++;
 578         }
 579         g_strfreev(tokens);
 580         g_free(response);
 581
 582         if (response_array->len == 0) {
 583                 g_array_free(response_array, TRUE);
 584                 *scpi_response = NULL;
 585                 return SR_ERR;
 586         }
 587
 588         *scpi_response = response_array;
 589
 590         return ret;
 591 }
 592
 593 /**
 594  * Send the *IDN? SCPI command, receive the reply, parse it and store the
 595  * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
 596  *
 597  * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
 598  *
 599  * @param scpi Previously initialised SCPI device structure.
 600  * @param scpi_response Pointer where to store the hw_info structure.
 601  *
 602  * @return SR_OK upon success, SR_ERR on failure.
 603  */
 604 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
 605                               struct sr_scpi_hw_info **scpi_response)
 606 {
 607         int num_tokens;
 608         char *response;
 609         gchar **tokens;
 610         struct sr_scpi_hw_info *hw_info;
 611
 612         response = NULL;
 613         tokens = NULL;
 614
 615         if (sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response) != SR_OK)
 616                 if (!response)
 617                         return SR_ERR;
 618
 619         sr_info("Got IDN string: '%s'", response);
 620
 621         /*
 622          * The response to a '*IDN?' is specified by the SCPI spec. It contains
 623          * a comma-separated list containing the manufacturer name, instrument
 624          * model, serial number of the instrument and the firmware version.
 625          */
 626         tokens = g_strsplit(response, ",", 0);
 627
 628         for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
 629
 630         if (num_tokens != 4) {
 631                 sr_dbg("IDN response not according to spec: %80.s.", response);
 632                 g_strfreev(tokens);
 633                 g_free(response);
 634                 return SR_ERR;
 635         }
 636         g_free(response);
 637
 638         hw_info = g_try_malloc(sizeof(struct sr_scpi_hw_info));
 639         if (!hw_info) {
 640                 g_strfreev(tokens);
 641                 return SR_ERR_MALLOC;
 642         }
 643
 644         hw_info->manufacturer = g_strdup(tokens[0]);
 645         hw_info->model = g_strdup(tokens[1]);
 646         hw_info->serial_number = g_strdup(tokens[2]);
 647         hw_info->firmware_version = g_strdup(tokens[3]);
 648
 649         g_strfreev(tokens);
 650
 651         *scpi_response = hw_info;
 652
 653         return SR_OK;
 654 }
 655
 656 /**
 657  * Free a sr_scpi_hw_info struct.
 658  *
 659  * @param hw_info Pointer to the struct to free.
 660  *
 661  * This function is safe to call with a NULL pointer.
 662  */
 663 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info)
 664 {
 665         if (hw_info) {
 666                 g_free(hw_info->manufacturer);
 667                 g_free(hw_info->model);
 668                 g_free(hw_info->serial_number);
 669                 g_free(hw_info->firmware_version);
 670                 g_free(hw_info);
 671         }
 672 }