]> sigrok.org Git - libsigrok.git/blobdiff - src/scpi.h
output/csv: use intermediate time_t var, silence compiler warning
[libsigrok.git] / src / scpi.h
index c70bd930fd5b2e42d284be08973516790b68ad2c..634c2727110b88334dbabdc34074a8d7565f733a 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/** @file
-  * @internal
-  */
-
 #ifndef LIBSIGROK_SCPI_H
 #define LIBSIGROK_SCPI_H
 
 #define SCPI_CMD_OPC "*OPC?"
 
 enum {
-       SCPI_CMD_SET_TRIGGER_SOURCE = 1,
+       SCPI_CMD_GET_TIMEBASE = 1,
        SCPI_CMD_SET_TIMEBASE,
-       SCPI_CMD_SET_VERTICAL_DIV,
+       SCPI_CMD_GET_HORIZONTAL_DIV,
+       SCPI_CMD_GET_VERTICAL_SCALE,
+       SCPI_CMD_SET_VERTICAL_SCALE,
+       SCPI_CMD_GET_TRIGGER_SOURCE,
+       SCPI_CMD_SET_TRIGGER_SOURCE,
+       SCPI_CMD_GET_TRIGGER_SLOPE,
        SCPI_CMD_SET_TRIGGER_SLOPE,
+       SCPI_CMD_GET_TRIGGER_PATTERN,
+       SCPI_CMD_SET_TRIGGER_PATTERN,
+       SCPI_CMD_GET_HIGH_RESOLUTION,
+       SCPI_CMD_SET_HIGH_RESOLUTION,
+       SCPI_CMD_GET_PEAK_DETECTION,
+       SCPI_CMD_SET_PEAK_DETECTION,
+       SCPI_CMD_GET_COUPLING,
        SCPI_CMD_SET_COUPLING,
+       SCPI_CMD_GET_HORIZ_TRIGGERPOS,
        SCPI_CMD_SET_HORIZ_TRIGGERPOS,
        SCPI_CMD_GET_ANALOG_CHAN_STATE,
-       SCPI_CMD_GET_DIG_CHAN_STATE,
-       SCPI_CMD_GET_TIMEBASE,
-       SCPI_CMD_GET_VERTICAL_DIV,
-       SCPI_CMD_GET_VERTICAL_OFFSET,
-       SCPI_CMD_GET_TRIGGER_SOURCE,
-       SCPI_CMD_GET_HORIZ_TRIGGERPOS,
-       SCPI_CMD_GET_TRIGGER_SLOPE,
-       SCPI_CMD_GET_COUPLING,
        SCPI_CMD_SET_ANALOG_CHAN_STATE,
+       SCPI_CMD_GET_DIG_CHAN_STATE,
        SCPI_CMD_SET_DIG_CHAN_STATE,
+       SCPI_CMD_GET_VERTICAL_OFFSET,
        SCPI_CMD_GET_DIG_POD_STATE,
        SCPI_CMD_SET_DIG_POD_STATE,
        SCPI_CMD_GET_ANALOG_DATA,
        SCPI_CMD_GET_DIG_DATA,
        SCPI_CMD_GET_SAMPLE_RATE,
-       SCPI_CMD_GET_SAMPLE_RATE_LIVE,
+       SCPI_CMD_GET_PROBE_UNIT,
+       SCPI_CMD_GET_DIG_POD_THRESHOLD,
+       SCPI_CMD_SET_DIG_POD_THRESHOLD,
+       SCPI_CMD_GET_DIG_POD_USER_THRESHOLD,
+       SCPI_CMD_SET_DIG_POD_USER_THRESHOLD,
+};
+
+enum scpi_transport_layer {
+       SCPI_TRANSPORT_LIBGPIB,
+       SCPI_TRANSPORT_SERIAL,
+       SCPI_TRANSPORT_RAW_TCP,
+       SCPI_TRANSPORT_RIGOL_TCP,
+       SCPI_TRANSPORT_USBTMC,
+       SCPI_TRANSPORT_VISA,
+       SCPI_TRANSPORT_VXI,
 };
 
 struct scpi_command {
@@ -73,24 +90,30 @@ struct sr_scpi_hw_info {
 struct sr_scpi_dev_inst {
        const char *name;
        const char *prefix;
+       enum scpi_transport_layer transport;
        int priv_size;
        GSList *(*scan)(struct drv_context *drvc);
        int (*dev_inst_new)(void *priv, struct drv_context *drvc,
                const char *resource, char **params, const char *serialcomm);
        int (*open)(struct sr_scpi_dev_inst *scpi);
+       int (*connection_id)(struct sr_scpi_dev_inst *scpi, char **connection_id);
        int (*source_add)(struct sr_session *session, void *priv, int events,
                int timeout, sr_receive_data_callback cb, void *cb_data);
        int (*source_remove)(struct sr_session *session, void *priv);
        int (*send)(void *priv, const char *command);
        int (*read_begin)(void *priv);
        int (*read_data)(void *priv, char *buf, int maxlen);
+       int (*write_data)(void *priv, char *buf, int len);
        int (*read_complete)(void *priv);
        int (*close)(struct sr_scpi_dev_inst *scpi);
        void (*free)(void *priv);
-       unsigned int read_timeout_ms;
+       unsigned int read_timeout_us;
        void *priv;
        /* Only used for quirk workarounds, notably the Rigol DS1000 series. */
        uint64_t firmware_version;
+       GMutex scpi_mutex;
+       char *actual_channel_name;
+       gboolean no_opc_command;
 };
 
 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
@@ -98,6 +121,8 @@ SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
                const char *resource, const char *serialcomm);
 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
+SR_PRIV int sr_scpi_connection_id(struct sr_scpi_dev_inst *scpi,
+               char **connection_id);
 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
                struct sr_scpi_dev_inst *scpi, int events, int timeout,
                sr_receive_data_callback cb, void *cb_data);
@@ -109,10 +134,13 @@ SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
                const char *format, va_list args);
 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
+SR_PRIV int sr_scpi_write_data(struct sr_scpi_dev_inst *scpi, char *buf, int len);
 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
 
+SR_PRIV int sr_scpi_read_response(struct sr_scpi_dev_inst *scpi,
+                       GString *response, gint64 abs_timeout_us);
 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
                        const char *command, char **scpi_response);
 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
@@ -128,16 +156,32 @@ SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
                        const char *command, GArray **scpi_response);
 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
                        const char *command, GArray **scpi_response);
+SR_PRIV int sr_scpi_get_data(struct sr_scpi_dev_inst *scpi,
+                       const char *command, GString **scpi_response);
+SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
+                       const char *command, GByteArray **scpi_response);
 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
                        struct sr_scpi_hw_info **scpi_response);
 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
 
+SR_PRIV const char *sr_scpi_unquote_string(char *s);
+
 SR_PRIV const char *sr_vendor_alias(const char *raw_vendor);
-SR_PRIV const char *scpi_cmd_get(const struct scpi_command *cmdtable, int command);
-SR_PRIV int scpi_cmd(const struct sr_dev_inst *sdi,
-               const struct scpi_command *cmdtable, int command, ...);
-SR_PRIV int scpi_cmd_resp(const struct sr_dev_inst *sdi,
+SR_PRIV const char *sr_scpi_cmd_get(const struct scpi_command *cmdtable,
+               int command);
+SR_PRIV int sr_scpi_cmd(const struct sr_dev_inst *sdi,
+               const struct scpi_command *cmdtable,
+               int channel_command, const char *channel_name,
+               int command, ...);
+SR_PRIV int sr_scpi_cmd_resp(const struct sr_dev_inst *sdi,
                const struct scpi_command *cmdtable,
+               int channel_command, const char *channel_name,
                GVariant **gvar, const GVariantType *gvtype, int command, ...);
 
+/*--- GPIB only functions ---------------------------------------------------*/
+
+#ifdef HAVE_LIBGPIB
+SR_PRIV int sr_scpi_gpib_spoll(struct sr_scpi_dev_inst *scpi, char *buf);
+#endif
+
 #endif