forked from sigrokproject/libsigrok
-
Notifications
You must be signed in to change notification settings - Fork 2
/
scpi.h
187 lines (172 loc) · 6.71 KB
/
scpi.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
/*
* This file is part of the libsigrok project.
*
* Copyright (C) 2015 Bert Vermeulen <bert@biot.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBSIGROK_SCPI_H
#define LIBSIGROK_SCPI_H
#include <stdint.h>
#include <glib.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
#define SCPI_CMD_IDN "*IDN?"
#define SCPI_CMD_OPC "*OPC?"
enum {
SCPI_CMD_GET_TIMEBASE = 1,
SCPI_CMD_SET_TIMEBASE,
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_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_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 {
int command;
const char *string;
};
struct sr_scpi_hw_info {
char *manufacturer;
char *model;
char *serial_number;
char *firmware_version;
};
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_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,
struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi));
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);
SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
struct sr_scpi_dev_inst *scpi);
SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
const char *format, ...);
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,
const char *command, gboolean *scpi_response);
SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
const char *command, int *scpi_response);
SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
const char *command, float *scpi_response);
SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
const char *command, double *scpi_response);
SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
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 *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