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