]> sigrok.org Git - libsigrok.git/blame - src/hardware/scpi-dmm/api.c
raspberrypi-pico: protocol.c cleanup
[libsigrok.git] / src / hardware / scpi-dmm / api.c
CommitLineData
7a396ff5
GS
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2018 Gerhard Sittig <gerhard.sittig@gmx.net>
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
3cdad416 20#include <string.h>
7a396ff5
GS
21#include "protocol.h"
22
0617bb5a
GS
23static struct sr_dev_driver scpi_dmm_driver_info;
24
3cdad416
GS
25static const uint32_t scanopts[] = {
26 SR_CONF_CONN,
31e65c62 27 SR_CONF_SERIALCOMM,
3cdad416
GS
28};
29
30static const uint32_t drvopts[] = {
31 SR_CONF_MULTIMETER,
32};
33
1d2f9963 34static const uint32_t devopts_generic[] = {
3cdad416 35 SR_CONF_CONTINUOUS,
7d95afb9 36 SR_CONF_CONN | SR_CONF_GET,
3cdad416
GS
37 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
38 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
39 SR_CONF_MEASURED_QUANTITY | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
40};
41
a0418c20
GS
42static const uint32_t devopts_generic_range[] = {
43 SR_CONF_CONTINUOUS,
44 SR_CONF_CONN | SR_CONF_GET,
45 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
46 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
47 SR_CONF_MEASURED_QUANTITY | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
48 SR_CONF_RANGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
49};
50
3cdad416
GS
51static const struct scpi_command cmdset_agilent[] = {
52 { DMM_CMD_SETUP_REMOTE, "\n", },
118da66f 53 { DMM_CMD_SETUP_LOCAL, "SYST:LOC", },
3cdad416
GS
54 { DMM_CMD_SETUP_FUNC, "CONF:%s", },
55 { DMM_CMD_QUERY_FUNC, "CONF?", },
7fcdc35e 56 { DMM_CMD_START_ACQ, "INIT", },
3cdad416 57 { DMM_CMD_STOP_ACQ, "ABORT", },
b74cc88d 58 { DMM_CMD_QUERY_VALUE, "FETCH?", },
3cdad416 59 { DMM_CMD_QUERY_PREC, "CONF?", },
a0418c20
GS
60 { DMM_CMD_QUERY_RANGE_AUTO, "%s:RANGE:AUTO?", },
61 { DMM_CMD_QUERY_RANGE, "%s:RANGE?", },
b74cc88d 62 { DMM_CMD_SETUP_RANGE, "CONF:%s %s", },
3cdad416
GS
63 ALL_ZERO,
64};
65
a1619831 66/*
1c8110db 67 * cmdset_hp is used for the 34401A, which was added to this code after the
a1619831
AG
68 * 34405A and 34465A. It differs in starting the measurement with INIT: using
69 * MEAS without a trailing '?' (as used for the 34405A) is not valid for the
1c8110db
FS
70 * 34401A and gives an error.
71 * I'm surprised the same instruction sequence doesn't work and INIT may
72 * work for both, but I don't have the others to re-test.
a1619831 73 *
85cff5cf
MW
74 * cmdset_hp also works well for the 34410A, using cmdset_agilent throws an
75 * error on 'MEAS' without a '?'.
76 *
1c8110db
FS
77 * On the 34401A,
78 * MEAS <optional parameters> ? configures, arms, triggers and waits
a1619831
AG
79 * for a reading
80 * CONF <parameters> configures
1c8110db 81 * INIT prepares for triggering (trigger mode is not set, assumed
a1619831
AG
82 * internal - external might time out)
83 * *OPC waits for completion, and
84 * READ? retrieves the result
85 */
86static const struct scpi_command cmdset_hp[] = {
87 { DMM_CMD_SETUP_REMOTE, "\n", },
88 { DMM_CMD_SETUP_FUNC, "CONF:%s", },
89 { DMM_CMD_QUERY_FUNC, "CONF?", },
90 { DMM_CMD_START_ACQ, "INIT", },
91 { DMM_CMD_STOP_ACQ, "ABORT", },
92 { DMM_CMD_QUERY_VALUE, "READ?", },
93 { DMM_CMD_QUERY_PREC, "CONF?", },
94 ALL_ZERO,
95};
96
d0b602f0
TK
97static const struct scpi_command cmdset_gwinstek[] = {
98 { DMM_CMD_SETUP_REMOTE, "SYST:REM", },
4c80a272 99 { DMM_CMD_SETUP_LOCAL, "SYST:LOC", },
d0b602f0
TK
100 { DMM_CMD_SETUP_FUNC, "CONF:%s", },
101 { DMM_CMD_QUERY_FUNC, "CONF:STAT:FUNC?", },
102 { DMM_CMD_START_ACQ, "*CLS;SYST:REM", },
d0b602f0
TK
103 { DMM_CMD_QUERY_VALUE, "VAL1?", },
104 { DMM_CMD_QUERY_PREC, "SENS:DET:RATE?", },
105 ALL_ZERO,
106};
107
868fc65e
TK
108static const struct scpi_command cmdset_gwinstek_906x[] = {
109 { DMM_CMD_SETUP_REMOTE, "SYST:REM", },
4c80a272 110 { DMM_CMD_SETUP_LOCAL, "SYST:LOC", },
868fc65e
TK
111 { DMM_CMD_SETUP_FUNC, "CONF:%s", },
112 { DMM_CMD_QUERY_FUNC, "CONF?", },
860ee00a
TK
113 { DMM_CMD_START_ACQ, "INIT", },
114 { DMM_CMD_STOP_ACQ, "ABORT", },
868fc65e
TK
115 { DMM_CMD_QUERY_VALUE, "VAL1?", },
116 { DMM_CMD_QUERY_PREC, "SENS:DET:RATE?", },
117 ALL_ZERO,
118};
119
2111d157
PA
120static const struct scpi_command cmdset_owon[] = {
121 { DMM_CMD_SETUP_REMOTE, "SYST:REM", },
122 { DMM_CMD_SETUP_LOCAL, "SYST:LOC", },
123 { DMM_CMD_SETUP_FUNC, "CONF:%s", },
124 { DMM_CMD_QUERY_FUNC, "FUNC?", },
125 { DMM_CMD_QUERY_VALUE, "MEAS1?", },
126 ALL_ZERO,
127};
128
64d03de1 129static const struct mqopt_item mqopts_agilent_34405a[] = {
1de14d67 130 { SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "VOLT ", NO_DFLT_PREC, FLAGS_NONE, },
e90551c3 131 { SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "VOLT:AC ", NO_DFLT_PREC, FLAG_CONF_DELAY | FLAG_MEAS_DELAY, },
1de14d67 132 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "CURR ", NO_DFLT_PREC, FLAGS_NONE, },
e90551c3
GS
133 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "CURR:AC ", NO_DFLT_PREC, FLAG_CONF_DELAY | FLAG_MEAS_DELAY, },
134 { SR_MQ_RESISTANCE, 0, "RES", "RES ", NO_DFLT_PREC, FLAG_MEAS_DELAY, },
135 { SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "FRES ", NO_DFLT_PREC, FLAG_MEAS_DELAY, },
5bf642db 136 { SR_MQ_CONTINUITY, 0, "CONT", "CONT", -1, FLAG_NO_RANGE, },
1de14d67 137 { SR_MQ_CAPACITANCE, 0, "CAP", "CAP ", NO_DFLT_PREC, FLAGS_NONE, },
5bf642db 138 { SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "DIOD", -4, FLAG_NO_RANGE, },
e90551c3
GS
139 { SR_MQ_TEMPERATURE, 0, "TEMP", "TEMP ", NO_DFLT_PREC, FLAG_NO_RANGE | FLAG_MEAS_DELAY, },
140 { SR_MQ_FREQUENCY, 0, "FREQ", "FREQ ", NO_DFLT_PREC, FLAG_NO_RANGE | FLAG_MEAS_DELAY, },
3cdad416
GS
141};
142
a1619831 143static const struct mqopt_item mqopts_agilent_34401a[] = {
1de14d67
GS
144 { SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "VOLT ", NO_DFLT_PREC, FLAGS_NONE, },
145 { SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "VOLT:AC ", NO_DFLT_PREC, FLAGS_NONE, },
146 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "CURR ", NO_DFLT_PREC, FLAGS_NONE, },
147 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "CURR:AC ", NO_DFLT_PREC, FLAGS_NONE, },
148 { SR_MQ_RESISTANCE, 0, "RES", "RES ", NO_DFLT_PREC, FLAGS_NONE, },
149 { SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "FRES ", NO_DFLT_PREC, FLAGS_NONE, },
150 { SR_MQ_CONTINUITY, 0, "CONT", "CONT", -1, FLAGS_NONE, },
151 { SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "DIOD", -4, FLAGS_NONE, },
152 { SR_MQ_FREQUENCY, 0, "FREQ", "FREQ ", NO_DFLT_PREC, FLAGS_NONE, },
153 { SR_MQ_TIME, 0, "PER", "PER ", NO_DFLT_PREC, FLAGS_NONE, },
a1619831
AG
154};
155
d0b602f0 156static const struct mqopt_item mqopts_gwinstek_gdm8200a[] = {
1de14d67
GS
157 { SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "01", NO_DFLT_PREC, FLAGS_NONE, },
158 { SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "02", NO_DFLT_PREC, FLAGS_NONE, },
159 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "03", NO_DFLT_PREC, FLAGS_NONE, },
160 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "04", NO_DFLT_PREC, FLAGS_NONE, },
161 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "05", NO_DFLT_PREC, FLAGS_NONE, }, /* mA */
162 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "06", NO_DFLT_PREC, FLAGS_NONE, }, /* mA */
163 { SR_MQ_RESISTANCE, 0, "RES", "07", NO_DFLT_PREC, FLAGS_NONE, },
164 { SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "16", NO_DFLT_PREC, FLAGS_NONE, },
165 { SR_MQ_CONTINUITY, 0, "CONT", "13", -1, FLAGS_NONE, },
166 { SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "17", -4, FLAGS_NONE, },
167 { SR_MQ_TEMPERATURE, 0, "TEMP", "09", NO_DFLT_PREC, FLAGS_NONE, }, /* Celsius */
168 { SR_MQ_TEMPERATURE, 0, "TEMP", "15", NO_DFLT_PREC, FLAGS_NONE, }, /* Fahrenheit */
169 { SR_MQ_FREQUENCY, 0, "FREQ", "08", NO_DFLT_PREC, FLAGS_NONE, },
170 { SR_MQ_TIME, 0, "PER", "14", NO_DFLT_PREC, FLAGS_NONE, },
d0b602f0
TK
171};
172
868fc65e 173static const struct mqopt_item mqopts_gwinstek_gdm906x[] = {
1de14d67
GS
174 { SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "VOLT ", NO_DFLT_PREC, FLAGS_NONE, },
175 { SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "VOLT:AC", NO_DFLT_PREC, FLAGS_NONE, },
176 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "CURR ", NO_DFLT_PREC, FLAGS_NONE, },
177 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "CURR:AC", NO_DFLT_PREC, FLAGS_NONE, },
178 { SR_MQ_RESISTANCE, 0, "RES", "RES", NO_DFLT_PREC, FLAGS_NONE, },
179 { SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "FRES", NO_DFLT_PREC, FLAGS_NONE, },
180 { SR_MQ_CONTINUITY, 0, "CONT", "CONT", -1, FLAGS_NONE, },
181 { SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "DIOD", -4, FLAGS_NONE, },
182 { SR_MQ_TEMPERATURE, 0, "TEMP", "TEMP", NO_DFLT_PREC, FLAGS_NONE, },
183 { SR_MQ_FREQUENCY, 0, "FREQ", "FREQ", NO_DFLT_PREC, FLAGS_NONE, },
184 { SR_MQ_TIME, 0, "PER", "PER", NO_DFLT_PREC, FLAGS_NONE, },
185 { SR_MQ_CAPACITANCE, 0, "CAP", "CAP", NO_DFLT_PREC, FLAGS_NONE, },
868fc65e
TK
186};
187
2111d157 188static const struct mqopt_item mqopts_owon_xdm2041[] = {
1de14d67
GS
189 { SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "VOLT AC", NO_DFLT_PREC, FLAGS_NONE, },
190 { SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "VOLT", NO_DFLT_PREC, FLAGS_NONE, },
191 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "CURR AC", NO_DFLT_PREC, FLAGS_NONE, },
192 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "CURR", NO_DFLT_PREC, FLAGS_NONE, },
193 { SR_MQ_RESISTANCE, 0, "RES", "RES", NO_DFLT_PREC, FLAGS_NONE, },
194 { SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "FRES", NO_DFLT_PREC, FLAGS_NONE, },
195 { SR_MQ_CONTINUITY, 0, "CONT", "CONT", -1, FLAGS_NONE, },
196 { SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "DIOD", -4, FLAGS_NONE, },
197 { SR_MQ_TEMPERATURE, 0, "TEMP", "TEMP", NO_DFLT_PREC, FLAGS_NONE, },
198 { SR_MQ_FREQUENCY, 0, "FREQ", "FREQ", NO_DFLT_PREC, FLAGS_NONE, },
199 { SR_MQ_CAPACITANCE, 0, "CAP", "CAP", NO_DFLT_PREC, FLAGS_NONE, },
2111d157
PA
200};
201
b35faceb
E
202static const struct mqopt_item mqopts_siglent_sdm3055[] = {
203 { SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "VOLT ", NO_DFLT_PREC, FLAGS_NONE, },
204 { SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "VOLT:AC ", NO_DFLT_PREC, FLAGS_NONE, },
205 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "CURR ", NO_DFLT_PREC, FLAGS_NONE, },
206 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "CURR:AC ", NO_DFLT_PREC, FLAGS_NONE, },
207 { SR_MQ_RESISTANCE, 0, "RES", "RES ", NO_DFLT_PREC, FLAGS_NONE, },
208 { SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "FRES ", NO_DFLT_PREC, FLAGS_NONE, },
209 { SR_MQ_CONTINUITY, 0, "CONT", "CONT", -1, FLAGS_NONE, },
210 { SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "DIOD", -4, FLAGS_NONE, },
211 { SR_MQ_FREQUENCY, 0, "FREQ", "FREQ ", NO_DFLT_PREC, FLAGS_NONE, },
212 { SR_MQ_TIME, 0, "PER", "PER ", NO_DFLT_PREC, FLAGS_NONE, },
213 { SR_MQ_CAPACITANCE, 0, "CAP", "CAP", NO_DFLT_PREC, FLAGS_NONE, },
214};
215
3cdad416
GS
216SR_PRIV const struct scpi_dmm_model models[] = {
217 {
218 "Agilent", "34405A",
64d03de1 219 1, 5, cmdset_agilent, ARRAY_AND_SIZE(mqopts_agilent_34405a),
3cdad416 220 scpi_dmm_get_meas_agilent,
a0418c20 221 ARRAY_AND_SIZE(devopts_generic_range),
e90551c3 222 0, 200 * 1000, 2500 * 1000, 0, FALSE,
a0418c20 223 scpi_dmm_get_range_text, scpi_dmm_set_range_from_text, NULL,
3cdad416 224 },
85cff5cf
MW
225 {
226 "Agilent", "34410A",
227 1, 6, cmdset_hp, ARRAY_AND_SIZE(mqopts_agilent_34405a),
228 scpi_dmm_get_meas_agilent,
229 ARRAY_AND_SIZE(devopts_generic),
e90551c3 230 0, 0, 0, 0, FALSE,
a0418c20 231 NULL, NULL, NULL,
d8064712
SP
232 },
233 {
234 "Agilent", "34460A",
235 1, 6, cmdset_agilent, ARRAY_AND_SIZE(mqopts_agilent_34405a),
236 scpi_dmm_get_meas_agilent,
237 ARRAY_AND_SIZE(devopts_generic_range),
238 0, 0, 10 * 1000, 0, FALSE,
239 scpi_dmm_get_range_text, scpi_dmm_set_range_from_text, NULL,
85cff5cf 240 },
d0b602f0
TK
241 {
242 "GW", "GDM8251A",
243 1, 6, cmdset_gwinstek, ARRAY_AND_SIZE(mqopts_gwinstek_gdm8200a),
244 scpi_dmm_get_meas_gwinstek,
245 ARRAY_AND_SIZE(devopts_generic),
e90551c3 246 2500 * 1000, 0, 0, 0, FALSE,
a0418c20 247 NULL, NULL, NULL,
d0b602f0
TK
248 },
249 {
250 "GW", "GDM8255A",
251 1, 6, cmdset_gwinstek, ARRAY_AND_SIZE(mqopts_gwinstek_gdm8200a),
252 scpi_dmm_get_meas_gwinstek,
253 ARRAY_AND_SIZE(devopts_generic),
e90551c3 254 2500 * 1000, 0, 0, 0, FALSE,
a0418c20 255 NULL, NULL, NULL,
d0b602f0 256 },
868fc65e
TK
257 {
258 "GWInstek", "GDM9060",
259 1, 6, cmdset_gwinstek_906x, ARRAY_AND_SIZE(mqopts_gwinstek_gdm906x),
260 scpi_dmm_get_meas_agilent,
261 ARRAY_AND_SIZE(devopts_generic),
e90551c3 262 0, 0, 0, 0, FALSE,
a0418c20 263 NULL, NULL, NULL,
868fc65e
TK
264 },
265 {
266 "GWInstek", "GDM9061",
267 1, 6, cmdset_gwinstek_906x, ARRAY_AND_SIZE(mqopts_gwinstek_gdm906x),
268 scpi_dmm_get_meas_agilent,
269 ARRAY_AND_SIZE(devopts_generic),
e90551c3 270 0, 0, 0, 0, FALSE,
a0418c20 271 NULL, NULL, NULL,
868fc65e 272 },
25879a34
GS
273 {
274 "HP", "34401A",
275 1, 6, cmdset_hp, ARRAY_AND_SIZE(mqopts_agilent_34401a),
276 scpi_dmm_get_meas_agilent,
277 ARRAY_AND_SIZE(devopts_generic),
278 /* 34401A: typ. 1020ms for AC readings (default is 1000ms). */
e90551c3 279 1500 * 1000, 0, 0, 0, FALSE,
a0418c20 280 NULL, NULL, NULL,
25879a34
GS
281 },
282 {
283 "Keysight", "34465A",
e3c85285 284 1, 6, cmdset_agilent, ARRAY_AND_SIZE(mqopts_agilent_34405a),
25879a34 285 scpi_dmm_get_meas_agilent,
a0418c20 286 ARRAY_AND_SIZE(devopts_generic_range),
18426d1c 287 0, 0, 10 * 1000, 0, FALSE,
a0418c20 288 scpi_dmm_get_range_text, scpi_dmm_set_range_from_text, NULL,
25879a34 289 },
2111d157
PA
290 {
291 "OWON", "XDM2041",
292 1, 5, cmdset_owon, ARRAY_AND_SIZE(mqopts_owon_xdm2041),
293 scpi_dmm_get_meas_gwinstek,
294 ARRAY_AND_SIZE(devopts_generic),
e90551c3 295 0, 0, 0, 1e9, TRUE,
a0418c20 296 NULL, NULL, NULL,
2111d157 297 },
b35faceb
E
298 {
299 "Siglent", "SDM3055",
300 1, 5, cmdset_hp, ARRAY_AND_SIZE(mqopts_siglent_sdm3055),
301 scpi_dmm_get_meas_agilent,
302 ARRAY_AND_SIZE(devopts_generic),
303 0, 0, 0, 0, FALSE,
304 NULL, NULL, NULL,
305 },
3cdad416
GS
306};
307
308static const struct scpi_dmm_model *is_compatible(const char *vendor, const char *model)
7a396ff5 309{
3cdad416
GS
310 size_t i;
311 const struct scpi_dmm_model *entry;
312
313 for (i = 0; i < ARRAY_SIZE(models); i++) {
314 entry = &models[i];
315 if (!entry->vendor || !entry->model)
316 continue;
317 if (strcmp(vendor, entry->vendor) != 0)
318 continue;
319 if (strcmp(model, entry->model) != 0)
320 continue;
321 return entry;
322 }
7a396ff5 323
3cdad416
GS
324 return NULL;
325}
7a396ff5 326
ddeaa49d
PA
327/*
328 * Some devices (such as Owon XDM2041) do not support the standard
329 * OPeration Complete? command. This function tests the command with
330 * a short timeout, and returns TRUE if any reply (busy or not) is received.
331 */
332static gboolean probe_opc_support(struct sr_scpi_dev_inst *scpi)
333{
334 gboolean result;
335 GString *response;
336
337 response = g_string_sized_new(128);
338 result = TRUE;
339 if (sr_scpi_get_data(scpi, SCPI_CMD_OPC, &response) != SR_OK)
340 result = FALSE;
341 g_string_free(response, TRUE);
342
343 return result;
344}
345
3cdad416
GS
346static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
347{
348 struct sr_scpi_hw_info *hw_info;
349 int ret;
350 const char *vendor;
351 const struct scpi_dmm_model *model;
352 struct sr_dev_inst *sdi;
353 struct dev_context *devc;
354 size_t i;
355 gchar *channel_name;
4c80a272 356 const char *command;
3cdad416 357
28877994 358 ret = sr_scpi_get_hw_id(scpi, &hw_info);
3cdad416
GS
359 if (ret != SR_OK) {
360 sr_info("Could not get IDN response.");
361 return NULL;
362 }
363 vendor = sr_vendor_alias(hw_info->manufacturer);
364 model = is_compatible(vendor, hw_info->model);
365 if (!model) {
366 sr_scpi_hw_info_free(hw_info);
367 return NULL;
368 }
7a396ff5 369
cae328b5
GS
370 if (model->check_opc && !probe_opc_support(scpi))
371 scpi->no_opc_command = TRUE;
372
3cdad416
GS
373 sdi = g_malloc0(sizeof(*sdi));
374 sdi->vendor = g_strdup(hw_info->manufacturer);
375 sdi->model = g_strdup(hw_info->model);
376 sdi->version = g_strdup(hw_info->firmware_version);
377 sdi->serial_num = g_strdup(hw_info->serial_number);
378 sdi->conn = scpi;
379 sdi->driver = &scpi_dmm_driver_info;
380 sdi->inst_type = SR_INST_SCPI;
7d95afb9
GS
381 ret = sr_scpi_connection_id(scpi, &sdi->connection_id);
382 if (ret != SR_OK) {
383 g_free(sdi->connection_id);
384 sdi->connection_id = NULL;
385 }
3cdad416 386 sr_scpi_hw_info_free(hw_info);
1c8110db 387 if (model->read_timeout_us) /* non-default read timeout */
a1619831 388 scpi->read_timeout_us = model->read_timeout_us;
3cdad416
GS
389 devc = g_malloc0(sizeof(*devc));
390 sdi->priv = devc;
391 devc->num_channels = model->num_channels;
392 devc->cmdset = model->cmdset;
393 devc->model = model;
394
395 for (i = 0; i < devc->num_channels; i++) {
396 channel_name = g_strdup_printf("P%zu", i + 1);
397 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, channel_name);
398 }
399
4c80a272
TK
400 /*
401 * If device has DMM_CMD_SETUP_LOCAL command, send it now. To avoid
402 * leaving device in remote mode (if only a "scan" is run).
403 */
404 command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_SETUP_LOCAL);
405 if (command && *command) {
406 scpi_dmm_cmd_delay(scpi);
407 sr_scpi_send(scpi, command);
408 }
409
3cdad416
GS
410 return sdi;
411}
7a396ff5 412
3cdad416
GS
413static GSList *scan(struct sr_dev_driver *di, GSList *options)
414{
415 return sr_scpi_scan(di->context, options, probe_device);
7a396ff5
GS
416}
417
418static int dev_open(struct sr_dev_inst *sdi)
419{
3cdad416
GS
420 struct sr_scpi_dev_inst *scpi;
421 int ret;
7a396ff5 422
3cdad416
GS
423 scpi = sdi->conn;
424 ret = sr_scpi_open(scpi);
425 if (ret < 0) {
426 sr_err("Failed to open SCPI device: %s.", sr_strerror(ret));
427 return SR_ERR;
428 }
7a396ff5
GS
429
430 return SR_OK;
431}
432
433static int dev_close(struct sr_dev_inst *sdi)
434{
4c80a272 435 struct dev_context *devc;
3cdad416 436 struct sr_scpi_dev_inst *scpi;
4c80a272 437 const char *command;
7a396ff5 438
4c80a272 439 devc = sdi->priv;
3cdad416
GS
440 scpi = sdi->conn;
441 if (!scpi)
442 return SR_ERR_BUG;
7a396ff5 443
3cdad416
GS
444 sr_dbg("DIAG: sdi->status %d.", sdi->status - SR_ST_NOT_FOUND);
445 if (sdi->status <= SR_ST_INACTIVE)
446 return SR_OK;
447
4c80a272
TK
448 /*
449 * If device has DMM_CMD_SETUP_LOCAL command, send it now
450 * to avoid leaving device in remote mode.
451 */
452 command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_SETUP_LOCAL);
453 if (command && *command) {
454 scpi_dmm_cmd_delay(scpi);
455 sr_scpi_send(scpi, command);
456 }
457
3cdad416 458 return sr_scpi_close(scpi);
7a396ff5
GS
459}
460
461static int config_get(uint32_t key, GVariant **data,
462 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
463{
3cdad416
GS
464 struct dev_context *devc;
465 enum sr_mq mq;
466 enum sr_mqflag mqflag;
467 GVariant *arr[2];
7a396ff5 468 int ret;
a0418c20 469 const char *range;
7a396ff5 470
7a396ff5
GS
471 (void)cg;
472
3cdad416
GS
473 devc = sdi->priv;
474
7a396ff5 475 switch (key) {
7d95afb9
GS
476 case SR_CONF_CONN:
477 if (!sdi || !sdi->connection_id)
478 return SR_ERR_NA;
479 *data = g_variant_new_string(sdi->connection_id);
480 return SR_OK;
3cdad416
GS
481 case SR_CONF_LIMIT_SAMPLES:
482 case SR_CONF_LIMIT_MSEC:
483 return sr_sw_limits_config_get(&devc->limits, key, data);
484 case SR_CONF_MEASURED_QUANTITY:
08f3b427 485 ret = scpi_dmm_get_mq(sdi, &mq, &mqflag, NULL, NULL);
3cdad416
GS
486 if (ret != SR_OK)
487 return ret;
488 arr[0] = g_variant_new_uint32(mq);
489 arr[1] = g_variant_new_uint64(mqflag);
490 *data = g_variant_new_tuple(arr, ARRAY_SIZE(arr));
491 return SR_OK;
a0418c20
GS
492 case SR_CONF_RANGE:
493 if (!devc || !devc->model->get_range_text)
494 return SR_ERR_NA;
495 range = devc->model->get_range_text(sdi);
496 if (!range || !*range)
497 return SR_ERR_NA;
498 *data = g_variant_new_string(range);
499 return SR_OK;
7a396ff5
GS
500 default:
501 return SR_ERR_NA;
502 }
7a396ff5
GS
503}
504
505static int config_set(uint32_t key, GVariant *data,
506 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
507{
3cdad416
GS
508 struct dev_context *devc;
509 enum sr_mq mq;
510 enum sr_mqflag mqflag;
511 GVariant *tuple_child;
a0418c20 512 const char *range;
7a396ff5 513
7a396ff5
GS
514 (void)cg;
515
3cdad416
GS
516 devc = sdi->priv;
517
7a396ff5 518 switch (key) {
3cdad416
GS
519 case SR_CONF_LIMIT_SAMPLES:
520 case SR_CONF_LIMIT_MSEC:
521 return sr_sw_limits_config_set(&devc->limits, key, data);
522 case SR_CONF_MEASURED_QUANTITY:
523 tuple_child = g_variant_get_child_value(data, 0);
524 mq = g_variant_get_uint32(tuple_child);
ff5fb185 525 g_variant_unref(tuple_child);
3cdad416
GS
526 tuple_child = g_variant_get_child_value(data, 1);
527 mqflag = g_variant_get_uint64(tuple_child);
528 g_variant_unref(tuple_child);
529 return scpi_dmm_set_mq(sdi, mq, mqflag);
a0418c20
GS
530 case SR_CONF_RANGE:
531 if (!devc || !devc->model->set_range_from_text)
532 return SR_ERR_NA;
533 range = g_variant_get_string(data, NULL);
534 return devc->model->set_range_from_text(sdi, range);
7a396ff5 535 default:
3cdad416 536 return SR_ERR_NA;
7a396ff5 537 }
7a396ff5
GS
538}
539
540static int config_list(uint32_t key, GVariant **data,
541 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
542{
3cdad416
GS
543 struct dev_context *devc;
544 GVariant *gvar, *arr[2];
545 GVariantBuilder gvb;
546 size_t i;
7a396ff5 547
7a396ff5
GS
548 (void)cg;
549
3cdad416
GS
550 devc = sdi ? sdi->priv : NULL;
551
7a396ff5 552 switch (key) {
3cdad416
GS
553 case SR_CONF_SCAN_OPTIONS:
554 case SR_CONF_DEVICE_OPTIONS:
1d2f9963
GS
555 if (!devc)
556 return STD_CONFIG_LIST(key, data, sdi, cg,
557 scanopts, drvopts, devopts_generic);
558 return std_opts_config_list(key, data, sdi, cg,
559 ARRAY_AND_SIZE(scanopts), ARRAY_AND_SIZE(drvopts),
560 devc->model->devopts, devc->model->devopts_size);
3cdad416
GS
561 case SR_CONF_MEASURED_QUANTITY:
562 /* TODO Use std_gvar_measured_quantities() when available. */
563 if (!devc)
564 return SR_ERR_ARG;
565 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
566 for (i = 0; i < devc->model->mqopt_size; i++) {
567 arr[0] = g_variant_new_uint32(devc->model->mqopts[i].mq);
568 arr[1] = g_variant_new_uint64(devc->model->mqopts[i].mqflag);
569 gvar = g_variant_new_tuple(arr, ARRAY_SIZE(arr));
570 g_variant_builder_add_value(&gvb, gvar);
571 }
572 *data = g_variant_builder_end(&gvb);
573 return SR_OK;
a0418c20
GS
574 case SR_CONF_RANGE:
575 if (!devc || !devc->model->get_range_text_list)
576 return SR_ERR_NA;
577 *data = devc->model->get_range_text_list(sdi);
578 return SR_OK;
7a396ff5 579 default:
3cdad416 580 (void)devc;
7a396ff5
GS
581 return SR_ERR_NA;
582 }
7a396ff5
GS
583}
584
585static int dev_acquisition_start(const struct sr_dev_inst *sdi)
586{
3cdad416
GS
587 struct sr_scpi_dev_inst *scpi;
588 struct dev_context *devc;
589 int ret;
08f3b427 590 const struct mqopt_item *item;
3cdad416 591 const char *command;
d0b602f0 592 char *response;
e90551c3 593 gboolean do_mq_meas_delay;
3cdad416
GS
594
595 scpi = sdi->conn;
596 devc = sdi->priv;
597
598 ret = scpi_dmm_get_mq(sdi, &devc->start_acq_mq.curr_mq,
08f3b427 599 &devc->start_acq_mq.curr_mqflag, NULL, &item);
3cdad416
GS
600 if (ret != SR_OK)
601 return ret;
602
d0b602f0
TK
603 /*
604 * Query for current precision if DMM supports the command
605 */
606 command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_QUERY_PREC);
607 if (command && *command) {
608 scpi_dmm_cmd_delay(scpi);
609 ret = sr_scpi_get_string(scpi, command, &response);
610 if (ret == SR_OK) {
611 g_strstrip(response);
33aa8117
GS
612 g_free(devc->precision);
613 devc->precision = g_strdup(response);
d0b602f0
TK
614 g_free(response);
615 sr_dbg("%s: Precision: '%s'", __func__, devc->precision);
616 } else {
33aa8117
GS
617 sr_info("Precision query ('%s') failed: %d",
618 command, ret);
d0b602f0
TK
619 }
620 }
621
3cdad416
GS
622 command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_START_ACQ);
623 if (command && *command) {
3cdad416 624 scpi_dmm_cmd_delay(scpi);
28877994 625 ret = sr_scpi_send(scpi, command);
3cdad416
GS
626 if (ret != SR_OK)
627 return ret;
628 }
7a396ff5 629
e90551c3
GS
630 do_mq_meas_delay = item->drv_flags & FLAG_MEAS_DELAY;
631 if (do_mq_meas_delay && devc->model->meas_delay_us)
632 g_usleep(devc->model->meas_delay_us);
633
3cdad416
GS
634 sr_sw_limits_acquisition_start(&devc->limits);
635 ret = std_session_send_df_header(sdi);
636 if (ret != SR_OK)
637 return ret;
638
639 ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
640 scpi_dmm_receive_data, (void *)sdi);
641 if (ret != SR_OK)
642 return ret;
7a396ff5
GS
643
644 return SR_OK;
645}
646
647static int dev_acquisition_stop(struct sr_dev_inst *sdi)
648{
3cdad416
GS
649 struct sr_scpi_dev_inst *scpi;
650 struct dev_context *devc;
651 const char *command;
652
653 scpi = sdi->conn;
654 devc = sdi->priv;
7a396ff5 655
3cdad416
GS
656 command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_STOP_ACQ);
657 if (command && *command) {
3cdad416 658 scpi_dmm_cmd_delay(scpi);
28877994 659 (void)sr_scpi_send(scpi, command);
3cdad416
GS
660 }
661 sr_scpi_source_remove(sdi->session, scpi);
662
663 std_session_send_df_end(sdi);
7a396ff5 664
33aa8117
GS
665 g_free(devc->precision);
666 devc->precision = NULL;
d0b602f0 667
7a396ff5
GS
668 return SR_OK;
669}
670
0617bb5a 671static struct sr_dev_driver scpi_dmm_driver_info = {
7a396ff5
GS
672 .name = "scpi-dmm",
673 .longname = "SCPI DMM",
674 .api_version = 1,
675 .init = std_init,
676 .cleanup = std_cleanup,
677 .scan = scan,
678 .dev_list = std_dev_list,
679 .dev_clear = std_dev_clear,
680 .config_get = config_get,
681 .config_set = config_set,
682 .config_list = config_list,
683 .dev_open = dev_open,
684 .dev_close = dev_close,
685 .dev_acquisition_start = dev_acquisition_start,
686 .dev_acquisition_stop = dev_acquisition_stop,
687 .context = NULL,
688};
7a396ff5 689SR_REGISTER_DEV_DRIVER(scpi_dmm_driver_info);