2 * This file is part of the libsigrok project.
4 * Copyright (C) 2018 Gerhard Sittig <gerhard.sittig@gmx.net>
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.
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.
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/>.
23 static struct sr_dev_driver scpi_dmm_driver_info;
25 static const uint32_t scanopts[] = {
30 static const uint32_t drvopts[] = {
34 static const uint32_t devopts_generic[] = {
36 SR_CONF_CONN | SR_CONF_GET,
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,
42 static const struct scpi_command cmdset_agilent[] = {
43 { DMM_CMD_SETUP_REMOTE, "\n", },
44 { DMM_CMD_SETUP_FUNC, "CONF:%s", },
45 { DMM_CMD_QUERY_FUNC, "CONF?", },
46 { DMM_CMD_START_ACQ, "MEAS", },
47 { DMM_CMD_STOP_ACQ, "ABORT", },
48 { DMM_CMD_QUERY_VALUE, "READ?", },
49 { DMM_CMD_QUERY_PREC, "CONF?", },
54 * cmdset_hp is used for the 34401A, which was added to this code after the
55 * 34405A and 34465A. It differs in starting the measurement with INIT: using
56 * MEAS without a trailing '?' (as used for the 34405A) is not valid for the
57 * 34401A and gives an error.
58 * I'm surprised the same instruction sequence doesn't work and INIT may
59 * work for both, but I don't have the others to re-test.
61 * cmdset_hp also works well for the 34410A, using cmdset_agilent throws an
62 * error on 'MEAS' without a '?'.
65 * MEAS <optional parameters> ? configures, arms, triggers and waits
67 * CONF <parameters> configures
68 * INIT prepares for triggering (trigger mode is not set, assumed
69 * internal - external might time out)
70 * *OPC waits for completion, and
71 * READ? retrieves the result
73 static const struct scpi_command cmdset_hp[] = {
74 { DMM_CMD_SETUP_REMOTE, "\n", },
75 { DMM_CMD_SETUP_FUNC, "CONF:%s", },
76 { DMM_CMD_QUERY_FUNC, "CONF?", },
77 { DMM_CMD_START_ACQ, "INIT", },
78 { DMM_CMD_STOP_ACQ, "ABORT", },
79 { DMM_CMD_QUERY_VALUE, "READ?", },
80 { DMM_CMD_QUERY_PREC, "CONF?", },
84 static const struct scpi_command cmdset_gwinstek[] = {
85 { DMM_CMD_SETUP_REMOTE, "SYST:REM", },
86 { DMM_CMD_SETUP_LOCAL, "SYST:LOC", },
87 { DMM_CMD_SETUP_FUNC, "CONF:%s", },
88 { DMM_CMD_QUERY_FUNC, "CONF:STAT:FUNC?", },
89 { DMM_CMD_START_ACQ, "*CLS;SYST:REM", },
90 { DMM_CMD_QUERY_VALUE, "VAL1?", },
91 { DMM_CMD_QUERY_PREC, "SENS:DET:RATE?", },
95 static const struct scpi_command cmdset_gwinstek_906x[] = {
96 { DMM_CMD_SETUP_REMOTE, "SYST:REM", },
97 { DMM_CMD_SETUP_LOCAL, "SYST:LOC", },
98 { DMM_CMD_SETUP_FUNC, "CONF:%s", },
99 { DMM_CMD_QUERY_FUNC, "CONF?", },
100 { DMM_CMD_START_ACQ, "INIT", },
101 { DMM_CMD_STOP_ACQ, "ABORT", },
102 { DMM_CMD_QUERY_VALUE, "VAL1?", },
103 { DMM_CMD_QUERY_PREC, "SENS:DET:RATE?", },
107 static const struct scpi_command cmdset_owon[] = {
108 { DMM_CMD_SETUP_REMOTE, "SYST:REM", },
109 { DMM_CMD_SETUP_LOCAL, "SYST:LOC", },
110 { DMM_CMD_SETUP_FUNC, "CONF:%s", },
111 { DMM_CMD_QUERY_FUNC, "FUNC?", },
112 { DMM_CMD_QUERY_VALUE, "MEAS1?", },
116 static const struct mqopt_item mqopts_agilent_34405a[] = {
117 { SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "VOLT ", NO_DFLT_PREC, },
118 { SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "VOLT:AC ", NO_DFLT_PREC, },
119 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "CURR ", NO_DFLT_PREC, },
120 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "CURR:AC ", NO_DFLT_PREC, },
121 { SR_MQ_RESISTANCE, 0, "RES", "RES ", NO_DFLT_PREC, },
122 { SR_MQ_CONTINUITY, 0, "CONT", "CONT", -1, },
123 { SR_MQ_CAPACITANCE, 0, "CAP", "CAP ", NO_DFLT_PREC, },
124 { SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "DIOD", -4, },
125 { SR_MQ_TEMPERATURE, 0, "TEMP", "TEMP ", NO_DFLT_PREC, },
126 { SR_MQ_FREQUENCY, 0, "FREQ", "FREQ ", NO_DFLT_PREC, },
129 static const struct mqopt_item mqopts_agilent_34401a[] = {
130 { SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "VOLT ", NO_DFLT_PREC, },
131 { SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "VOLT:AC ", NO_DFLT_PREC, },
132 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "CURR ", NO_DFLT_PREC, },
133 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "CURR:AC ", NO_DFLT_PREC, },
134 { SR_MQ_RESISTANCE, 0, "RES", "RES ", NO_DFLT_PREC, },
135 { SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "FRES ", NO_DFLT_PREC, },
136 { SR_MQ_CONTINUITY, 0, "CONT", "CONT", -1, },
137 { SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "DIOD", -4, },
138 { SR_MQ_FREQUENCY, 0, "FREQ", "FREQ ", NO_DFLT_PREC, },
139 { SR_MQ_TIME, 0, "PER", "PER ", NO_DFLT_PREC, },
142 static const struct mqopt_item mqopts_gwinstek_gdm8200a[] = {
143 { SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "01", NO_DFLT_PREC, },
144 { SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "02", NO_DFLT_PREC, },
145 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "03", NO_DFLT_PREC, },
146 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "04", NO_DFLT_PREC, },
147 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "05", NO_DFLT_PREC, }, /* mA */
148 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "06", NO_DFLT_PREC, }, /* mA */
149 { SR_MQ_RESISTANCE, 0, "RES", "07", NO_DFLT_PREC, },
150 { SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "16", NO_DFLT_PREC, },
151 { SR_MQ_CONTINUITY, 0, "CONT", "13", -1, },
152 { SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "17", -4, },
153 { SR_MQ_TEMPERATURE, 0, "TEMP", "09", NO_DFLT_PREC, }, /* Celsius */
154 { SR_MQ_TEMPERATURE, 0, "TEMP", "15", NO_DFLT_PREC, }, /* Fahrenheit */
155 { SR_MQ_FREQUENCY, 0, "FREQ", "08", NO_DFLT_PREC, },
156 { SR_MQ_TIME, 0, "PER", "14", NO_DFLT_PREC, },
159 static const struct mqopt_item mqopts_gwinstek_gdm906x[] = {
160 { SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "VOLT ", NO_DFLT_PREC, },
161 { SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "VOLT:AC", NO_DFLT_PREC, },
162 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "CURR ", NO_DFLT_PREC, },
163 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "CURR:AC", NO_DFLT_PREC, },
164 { SR_MQ_RESISTANCE, 0, "RES", "RES", NO_DFLT_PREC, },
165 { SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "FRES", NO_DFLT_PREC, },
166 { SR_MQ_CONTINUITY, 0, "CONT", "CONT", -1, },
167 { SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "DIOD", -4, },
168 { SR_MQ_TEMPERATURE, 0, "TEMP", "TEMP", NO_DFLT_PREC, },
169 { SR_MQ_FREQUENCY, 0, "FREQ", "FREQ", NO_DFLT_PREC, },
170 { SR_MQ_TIME, 0, "PER", "PER", NO_DFLT_PREC, },
171 { SR_MQ_CAPACITANCE, 0, "CAP", "CAP", NO_DFLT_PREC, },
174 static const struct mqopt_item mqopts_owon_xdm2041[] = {
175 { SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "VOLT AC", NO_DFLT_PREC, },
176 { SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "VOLT", NO_DFLT_PREC, },
177 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "CURR AC", NO_DFLT_PREC, },
178 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "CURR", NO_DFLT_PREC, },
179 { SR_MQ_RESISTANCE, 0, "RES", "RES", NO_DFLT_PREC, },
180 { SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "FRES", NO_DFLT_PREC, },
181 { SR_MQ_CONTINUITY, 0, "CONT", "CONT", -1, },
182 { SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "DIOD", -4, },
183 { SR_MQ_TEMPERATURE, 0, "TEMP", "TEMP", NO_DFLT_PREC, },
184 { SR_MQ_FREQUENCY, 0, "FREQ", "FREQ", NO_DFLT_PREC, },
185 { SR_MQ_CAPACITANCE, 0, "CAP", "CAP", NO_DFLT_PREC, },
188 SR_PRIV const struct scpi_dmm_model models[] = {
191 1, 5, cmdset_agilent, ARRAY_AND_SIZE(mqopts_agilent_34405a),
192 scpi_dmm_get_meas_agilent,
193 ARRAY_AND_SIZE(devopts_generic),
198 1, 6, cmdset_hp, ARRAY_AND_SIZE(mqopts_agilent_34405a),
199 scpi_dmm_get_meas_agilent,
200 ARRAY_AND_SIZE(devopts_generic),
205 1, 6, cmdset_gwinstek, ARRAY_AND_SIZE(mqopts_gwinstek_gdm8200a),
206 scpi_dmm_get_meas_gwinstek,
207 ARRAY_AND_SIZE(devopts_generic),
208 1000 * 2500, 0, FALSE,
212 1, 6, cmdset_gwinstek, ARRAY_AND_SIZE(mqopts_gwinstek_gdm8200a),
213 scpi_dmm_get_meas_gwinstek,
214 ARRAY_AND_SIZE(devopts_generic),
215 1000 * 2500, 0, FALSE,
218 "GWInstek", "GDM9060",
219 1, 6, cmdset_gwinstek_906x, ARRAY_AND_SIZE(mqopts_gwinstek_gdm906x),
220 scpi_dmm_get_meas_agilent,
221 ARRAY_AND_SIZE(devopts_generic),
225 "GWInstek", "GDM9061",
226 1, 6, cmdset_gwinstek_906x, ARRAY_AND_SIZE(mqopts_gwinstek_gdm906x),
227 scpi_dmm_get_meas_agilent,
228 ARRAY_AND_SIZE(devopts_generic),
233 1, 6, cmdset_hp, ARRAY_AND_SIZE(mqopts_agilent_34401a),
234 scpi_dmm_get_meas_agilent,
235 ARRAY_AND_SIZE(devopts_generic),
236 /* 34401A: typ. 1020ms for AC readings (default is 1000ms). */
237 1000 * 1500, 0, FALSE,
240 "Keysight", "34465A",
241 1, 6, cmdset_agilent, ARRAY_AND_SIZE(mqopts_agilent_34405a),
242 scpi_dmm_get_meas_agilent,
243 ARRAY_AND_SIZE(devopts_generic),
248 1, 5, cmdset_owon, ARRAY_AND_SIZE(mqopts_owon_xdm2041),
249 scpi_dmm_get_meas_gwinstek,
250 ARRAY_AND_SIZE(devopts_generic),
255 static const struct scpi_dmm_model *is_compatible(const char *vendor, const char *model)
258 const struct scpi_dmm_model *entry;
260 for (i = 0; i < ARRAY_SIZE(models); i++) {
262 if (!entry->vendor || !entry->model)
264 if (strcmp(vendor, entry->vendor) != 0)
266 if (strcmp(model, entry->model) != 0)
275 * Some devices (such as Owon XDM2041) do not support the standard
276 * OPeration Complete? command. This function tests the command with
277 * a short timeout, and returns TRUE if any reply (busy or not) is received.
279 static gboolean probe_opc_support(struct sr_scpi_dev_inst *scpi)
284 response = g_string_sized_new(128);
286 if (sr_scpi_get_data(scpi, SCPI_CMD_OPC, &response) != SR_OK)
288 g_string_free(response, TRUE);
293 static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
295 struct sr_scpi_hw_info *hw_info;
298 const struct scpi_dmm_model *model;
299 struct sr_dev_inst *sdi;
300 struct dev_context *devc;
305 ret = sr_scpi_get_hw_id(scpi, &hw_info);
307 sr_info("Could not get IDN response.");
310 vendor = sr_vendor_alias(hw_info->manufacturer);
311 model = is_compatible(vendor, hw_info->model);
313 sr_scpi_hw_info_free(hw_info);
317 if (model->check_opc && !probe_opc_support(scpi))
318 scpi->no_opc_command = TRUE;
320 sdi = g_malloc0(sizeof(*sdi));
321 sdi->vendor = g_strdup(hw_info->manufacturer);
322 sdi->model = g_strdup(hw_info->model);
323 sdi->version = g_strdup(hw_info->firmware_version);
324 sdi->serial_num = g_strdup(hw_info->serial_number);
326 sdi->driver = &scpi_dmm_driver_info;
327 sdi->inst_type = SR_INST_SCPI;
328 ret = sr_scpi_connection_id(scpi, &sdi->connection_id);
330 g_free(sdi->connection_id);
331 sdi->connection_id = NULL;
333 sr_scpi_hw_info_free(hw_info);
334 if (model->read_timeout_us) /* non-default read timeout */
335 scpi->read_timeout_us = model->read_timeout_us;
336 devc = g_malloc0(sizeof(*devc));
338 devc->num_channels = model->num_channels;
339 devc->cmdset = model->cmdset;
342 for (i = 0; i < devc->num_channels; i++) {
343 channel_name = g_strdup_printf("P%zu", i + 1);
344 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, channel_name);
348 * If device has DMM_CMD_SETUP_LOCAL command, send it now. To avoid
349 * leaving device in remote mode (if only a "scan" is run).
351 command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_SETUP_LOCAL);
352 if (command && *command) {
353 scpi_dmm_cmd_delay(scpi);
354 sr_scpi_send(scpi, command);
360 static GSList *scan(struct sr_dev_driver *di, GSList *options)
362 return sr_scpi_scan(di->context, options, probe_device);
365 static int dev_open(struct sr_dev_inst *sdi)
367 struct sr_scpi_dev_inst *scpi;
371 ret = sr_scpi_open(scpi);
373 sr_err("Failed to open SCPI device: %s.", sr_strerror(ret));
380 static int dev_close(struct sr_dev_inst *sdi)
382 struct dev_context *devc;
383 struct sr_scpi_dev_inst *scpi;
391 sr_dbg("DIAG: sdi->status %d.", sdi->status - SR_ST_NOT_FOUND);
392 if (sdi->status <= SR_ST_INACTIVE)
396 * If device has DMM_CMD_SETUP_LOCAL command, send it now
397 * to avoid leaving device in remote mode.
399 command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_SETUP_LOCAL);
400 if (command && *command) {
401 scpi_dmm_cmd_delay(scpi);
402 sr_scpi_send(scpi, command);
405 return sr_scpi_close(scpi);
408 static int config_get(uint32_t key, GVariant **data,
409 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
411 struct dev_context *devc;
413 enum sr_mqflag mqflag;
423 if (!sdi || !sdi->connection_id)
425 *data = g_variant_new_string(sdi->connection_id);
427 case SR_CONF_LIMIT_SAMPLES:
428 case SR_CONF_LIMIT_MSEC:
429 return sr_sw_limits_config_get(&devc->limits, key, data);
430 case SR_CONF_MEASURED_QUANTITY:
431 ret = scpi_dmm_get_mq(sdi, &mq, &mqflag, NULL, NULL);
434 arr[0] = g_variant_new_uint32(mq);
435 arr[1] = g_variant_new_uint64(mqflag);
436 *data = g_variant_new_tuple(arr, ARRAY_SIZE(arr));
443 static int config_set(uint32_t key, GVariant *data,
444 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
446 struct dev_context *devc;
448 enum sr_mqflag mqflag;
449 GVariant *tuple_child;
456 case SR_CONF_LIMIT_SAMPLES:
457 case SR_CONF_LIMIT_MSEC:
458 return sr_sw_limits_config_set(&devc->limits, key, data);
459 case SR_CONF_MEASURED_QUANTITY:
460 tuple_child = g_variant_get_child_value(data, 0);
461 mq = g_variant_get_uint32(tuple_child);
462 g_variant_unref(tuple_child);
463 tuple_child = g_variant_get_child_value(data, 1);
464 mqflag = g_variant_get_uint64(tuple_child);
465 g_variant_unref(tuple_child);
466 return scpi_dmm_set_mq(sdi, mq, mqflag);
472 static int config_list(uint32_t key, GVariant **data,
473 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
475 struct dev_context *devc;
476 GVariant *gvar, *arr[2];
482 devc = sdi ? sdi->priv : NULL;
485 case SR_CONF_SCAN_OPTIONS:
486 case SR_CONF_DEVICE_OPTIONS:
488 return STD_CONFIG_LIST(key, data, sdi, cg,
489 scanopts, drvopts, devopts_generic);
490 return std_opts_config_list(key, data, sdi, cg,
491 ARRAY_AND_SIZE(scanopts), ARRAY_AND_SIZE(drvopts),
492 devc->model->devopts, devc->model->devopts_size);
493 case SR_CONF_MEASURED_QUANTITY:
494 /* TODO Use std_gvar_measured_quantities() when available. */
497 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
498 for (i = 0; i < devc->model->mqopt_size; i++) {
499 arr[0] = g_variant_new_uint32(devc->model->mqopts[i].mq);
500 arr[1] = g_variant_new_uint64(devc->model->mqopts[i].mqflag);
501 gvar = g_variant_new_tuple(arr, ARRAY_SIZE(arr));
502 g_variant_builder_add_value(&gvb, gvar);
504 *data = g_variant_builder_end(&gvb);
512 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
514 struct sr_scpi_dev_inst *scpi;
515 struct dev_context *devc;
517 const struct mqopt_item *item;
524 ret = scpi_dmm_get_mq(sdi, &devc->start_acq_mq.curr_mq,
525 &devc->start_acq_mq.curr_mqflag, NULL, &item);
530 * Query for current precision if DMM supports the command
532 command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_QUERY_PREC);
533 if (command && *command) {
534 scpi_dmm_cmd_delay(scpi);
535 ret = sr_scpi_get_string(scpi, command, &response);
537 g_strstrip(response);
538 g_free(devc->precision);
539 devc->precision = g_strdup(response);
541 sr_dbg("%s: Precision: '%s'", __func__, devc->precision);
543 sr_info("Precision query ('%s') failed: %d",
548 command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_START_ACQ);
549 if (command && *command) {
550 scpi_dmm_cmd_delay(scpi);
551 ret = sr_scpi_send(scpi, command);
556 sr_sw_limits_acquisition_start(&devc->limits);
557 ret = std_session_send_df_header(sdi);
561 ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
562 scpi_dmm_receive_data, (void *)sdi);
569 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
571 struct sr_scpi_dev_inst *scpi;
572 struct dev_context *devc;
578 command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_STOP_ACQ);
579 if (command && *command) {
580 scpi_dmm_cmd_delay(scpi);
581 (void)sr_scpi_send(scpi, command);
583 sr_scpi_source_remove(sdi->session, scpi);
585 std_session_send_df_end(sdi);
587 g_free(devc->precision);
588 devc->precision = NULL;
593 static struct sr_dev_driver scpi_dmm_driver_info = {
595 .longname = "SCPI DMM",
598 .cleanup = std_cleanup,
600 .dev_list = std_dev_list,
601 .dev_clear = std_dev_clear,
602 .config_get = config_get,
603 .config_set = config_set,
604 .config_list = config_list,
605 .dev_open = dev_open,
606 .dev_close = dev_close,
607 .dev_acquisition_start = dev_acquisition_start,
608 .dev_acquisition_stop = dev_acquisition_stop,
611 SR_REGISTER_DEV_DRIVER(scpi_dmm_driver_info);