src/scpi.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2015 Bert Vermeulen <bert@biot.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 /** @file
  21   * @internal
  22   */
  23
  24 #ifndef LIBSIGROK_SCPI_H
  25 #define LIBSIGROK_SCPI_H
  26
  27 #include <stdint.h>
  28 #include <glib.h>
  29 #include <libsigrok/libsigrok.h>
  30 #include "libsigrok-internal.h"
  31
  32 #define SCPI_CMD_IDN "*IDN?"
  33 #define SCPI_CMD_OPC "*OPC?"
  34
  35 enum {
  36         SCPI_CMD_SET_TRIGGER_SOURCE = 1,
  37         SCPI_CMD_SET_TIMEBASE,
  38         SCPI_CMD_SET_VERTICAL_DIV,
  39         SCPI_CMD_SET_TRIGGER_SLOPE,
  40         SCPI_CMD_SET_COUPLING,
  41         SCPI_CMD_SET_HORIZ_TRIGGERPOS,
  42         SCPI_CMD_GET_ANALOG_CHAN_STATE,
  43         SCPI_CMD_GET_DIG_CHAN_STATE,
  44         SCPI_CMD_GET_TIMEBASE,
  45         SCPI_CMD_GET_VERTICAL_DIV,
  46         SCPI_CMD_GET_VERTICAL_OFFSET,
  47         SCPI_CMD_GET_TRIGGER_SOURCE,
  48         SCPI_CMD_GET_HORIZ_TRIGGERPOS,
  49         SCPI_CMD_GET_TRIGGER_SLOPE,
  50         SCPI_CMD_GET_COUPLING,
  51         SCPI_CMD_SET_ANALOG_CHAN_STATE,
  52         SCPI_CMD_SET_DIG_CHAN_STATE,
  53         SCPI_CMD_GET_DIG_POD_STATE,
  54         SCPI_CMD_SET_DIG_POD_STATE,
  55         SCPI_CMD_GET_ANALOG_DATA,
  56         SCPI_CMD_GET_DIG_DATA,
  57         SCPI_CMD_GET_SAMPLE_RATE,
  58         SCPI_CMD_GET_SAMPLE_RATE_LIVE,
  59         SCPI_CMD_GET_DATA_FORMAT,
  60         SCPI_CMD_GET_PROBE_FACTOR,
  61         SCPI_CMD_SET_PROBE_FACTOR,
  62         SCPI_CMD_GET_PROBE_UNIT,
  63         SCPI_CMD_SET_PROBE_UNIT,
  64         SCPI_CMD_GET_ANALOG_CHAN_NAME,
  65         SCPI_CMD_GET_DIG_CHAN_NAME,
  66         SCPI_CMD_GET_DIG_POD_THRESHOLD,
  67         SCPI_CMD_SET_DIG_POD_THRESHOLD,
  68         SCPI_CMD_GET_DIG_POD_USER_THRESHOLD,
  69         SCPI_CMD_SET_DIG_POD_USER_THRESHOLD,
  70 };
  71
  72 enum scpi_transport_layer {
  73         SCPI_TRANSPORT_LIBGPIB,
  74         SCPI_TRANSPORT_SERIAL,
  75         SCPI_TRANSPORT_RAW_TCP,
  76         SCPI_TRANSPORT_RIGOL_TCP,
  77         SCPI_TRANSPORT_USBTMC,
  78         SCPI_TRANSPORT_VISA,
  79         SCPI_TRANSPORT_VXI,
  80 };
  81
  82 struct scpi_command {
  83         int command;
  84         const char *string;
  85 };
  86
  87 struct sr_scpi_hw_info {
  88         char *manufacturer;
  89         char *model;
  90         char *serial_number;
  91         char *firmware_version;
  92 };
  93
  94 struct sr_scpi_dev_inst {
  95         const char *name;
  96         const char *prefix;
  97         enum scpi_transport_layer transport;
  98         int priv_size;
  99         GSList *(*scan)(struct drv_context *drvc);
 100         int (*dev_inst_new)(void *priv, struct drv_context *drvc,
 101                 const char *resource, char **params, const char *serialcomm);
 102         int (*open)(struct sr_scpi_dev_inst *scpi);
 103         int (*connection_id)(struct sr_scpi_dev_inst *scpi, char **connection_id);
 104         int (*source_add)(struct sr_session *session, void *priv, int events,
 105                 int timeout, sr_receive_data_callback cb, void *cb_data);
 106         int (*source_remove)(struct sr_session *session, void *priv);
 107         int (*send)(void *priv, const char *command);
 108         int (*read_begin)(void *priv);
 109         int (*read_data)(void *priv, char *buf, int maxlen);
 110         int (*write_data)(void *priv, char *buf, int len);
 111         int (*read_complete)(void *priv);
 112         int (*close)(struct sr_scpi_dev_inst *scpi);
 113         void (*free)(void *priv);
 114         unsigned int read_timeout_us;
 115         void *priv;
 116         /* Only used for quirk workarounds, notably the Rigol DS1000 series. */
 117         uint64_t firmware_version;
 118         GMutex scpi_mutex;
 119         char *actual_channel_name;
 120 };
 121
 122 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
 123                 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi));
 124 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
 125                 const char *resource, const char *serialcomm);
 126 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
 127 SR_PRIV int sr_scpi_connection_id(struct sr_scpi_dev_inst *scpi,
 128                 char **connection_id);
 129 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
 130                 struct sr_scpi_dev_inst *scpi, int events, int timeout,
 131                 sr_receive_data_callback cb, void *cb_data);
 132 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
 133                 struct sr_scpi_dev_inst *scpi);
 134 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
 135                 const char *format, ...);
 136 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
 137                 const char *format, va_list args);
 138 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
 139 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
 140 SR_PRIV int sr_scpi_write_data(struct sr_scpi_dev_inst *scpi, char *buf, int len);
 141 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
 142 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
 143 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
 144
 145 SR_PRIV int sr_scpi_read_response(struct sr_scpi_dev_inst *scpi,
 146                         GString *response, gint64 abs_timeout_us);
 147 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
 148                         const char *command, char **scpi_response);
 149 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
 150                         const char *command, gboolean *scpi_response);
 151 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
 152                         const char *command, int *scpi_response);
 153 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
 154                         const char *command, float *scpi_response);
 155 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
 156                         const char *command, double *scpi_response);
 157 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
 158 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
 159                         const char *command, GArray **scpi_response);
 160 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
 161                         const char *command, GArray **scpi_response);
 162 SR_PRIV int sr_scpi_get_data(struct sr_scpi_dev_inst *scpi,
 163                         const char *command, GString **scpi_response);
 164 SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
 165                         const char *command, GByteArray **scpi_response);
 166 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
 167                         struct sr_scpi_hw_info **scpi_response);
 168 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
 169
 170 SR_PRIV const char *sr_scpi_unquote_string(char *s);
 171
 172 SR_PRIV const char *sr_vendor_alias(const char *raw_vendor);
 173 SR_PRIV const char *sr_scpi_cmd_get(const struct scpi_command *cmdtable,
 174                 int command);
 175 SR_PRIV int sr_scpi_cmd(const struct sr_dev_inst *sdi,
 176                 const struct scpi_command *cmdtable,
 177                 int channel_command, const char *channel_name,
 178                 int command, ...);
 179 SR_PRIV int sr_scpi_cmd_resp(const struct sr_dev_inst *sdi,
 180                 const struct scpi_command *cmdtable,
 181                 int channel_command, const char *channel_name,
 182                 GVariant **gvar, const GVariantType *gvtype, int command, ...);
 183
 184 /*--- GPIB only functions ---------------------------------------------------*/
 185
 186 #ifdef HAVE_LIBGPIB
 187 SR_PRIV int sr_scpi_gpib_spoll(struct sr_scpi_dev_inst *scpi, char *buf);
 188 #endif
 189
 190 #endif