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_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
37 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
38 SR_CONF_MEASURED_QUANTITY | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
41 static const struct scpi_command cmdset_agilent[] = {
42 { DMM_CMD_SETUP_REMOTE, "\n", },
43 { DMM_CMD_SETUP_FUNC, "CONF:%s", },
44 { DMM_CMD_QUERY_FUNC, "CONF?", },
45 { DMM_CMD_START_ACQ, "MEAS", },
46 { DMM_CMD_STOP_ACQ, "ABORT", },
47 { DMM_CMD_QUERY_VALUE, "READ?", },
48 { DMM_CMD_QUERY_PREC, "CONF?", },
53 * cmdset_hp is used for the 34401A, which was added to this code after the
54 * 34405A and 34465A. It differs in starting the measurement with INIT: using
55 * MEAS without a trailing '?' (as used for the 34405A) is not valid for the
56 * 34401A and gives an error.
57 * I'm surprised the same instruction sequence doesn't work and INIT may
58 * work for both, but I don't have the others to re-test.
60 * cmdset_hp also works well for the 34410A, using cmdset_agilent throws an
61 * error on 'MEAS' without a '?'.
64 * MEAS <optional parameters> ? configures, arms, triggers and waits
66 * CONF <parameters> configures
67 * INIT prepares for triggering (trigger mode is not set, assumed
68 * internal - external might time out)
69 * *OPC waits for completion, and
70 * READ? retrieves the result
72 static const struct scpi_command cmdset_hp[] = {
73 { DMM_CMD_SETUP_REMOTE, "\n", },
74 { DMM_CMD_SETUP_FUNC, "CONF:%s", },
75 { DMM_CMD_QUERY_FUNC, "CONF?", },
76 { DMM_CMD_START_ACQ, "INIT", },
77 { DMM_CMD_STOP_ACQ, "ABORT", },
78 { DMM_CMD_QUERY_VALUE, "READ?", },
79 { DMM_CMD_QUERY_PREC, "CONF?", },
83 static const struct scpi_command cmdset_gwinstek[] = {
84 { DMM_CMD_SETUP_REMOTE, "SYST:REM", },
85 { DMM_CMD_SETUP_FUNC, "CONF:%s", },
86 { DMM_CMD_QUERY_FUNC, "CONF:STAT:FUNC?", },
87 { DMM_CMD_START_ACQ, "*CLS;SYST:REM", },
88 { DMM_CMD_STOP_ACQ, "SYST:LOC", },
89 { DMM_CMD_QUERY_VALUE, "VAL1?", },
90 { DMM_CMD_QUERY_PREC, "SENS:DET:RATE?", },
94 static const struct scpi_command cmdset_gwinstek_906x[] = {
95 { DMM_CMD_SETUP_REMOTE, "SYST:REM", },
96 { DMM_CMD_SETUP_FUNC, "CONF:%s", },
97 { DMM_CMD_QUERY_FUNC, "CONF?", },
98 { DMM_CMD_START_ACQ, "*CLS;SYST:REM", },
99 { DMM_CMD_STOP_ACQ, "SYST:LOC", },
100 { DMM_CMD_QUERY_VALUE, "VAL1?", },
101 { DMM_CMD_QUERY_PREC, "SENS:DET:RATE?", },
105 static const struct mqopt_item mqopts_agilent_34405a[] = {
106 { SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "VOLT ", NO_DFLT_PREC, },
107 { SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "VOLT:AC ", NO_DFLT_PREC, },
108 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "CURR ", NO_DFLT_PREC, },
109 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "CURR:AC ", NO_DFLT_PREC, },
110 { SR_MQ_RESISTANCE, 0, "RES", "RES ", NO_DFLT_PREC, },
111 { SR_MQ_CONTINUITY, 0, "CONT", "CONT", -1, },
112 { SR_MQ_CAPACITANCE, 0, "CAP", "CAP ", NO_DFLT_PREC, },
113 { SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "DIOD", -4, },
114 { SR_MQ_TEMPERATURE, 0, "TEMP", "TEMP ", NO_DFLT_PREC, },
115 { SR_MQ_FREQUENCY, 0, "FREQ", "FREQ ", NO_DFLT_PREC, },
118 static const struct mqopt_item mqopts_agilent_34401a[] = {
119 { SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "VOLT ", NO_DFLT_PREC, },
120 { SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "VOLT:AC ", NO_DFLT_PREC, },
121 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "CURR ", NO_DFLT_PREC, },
122 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "CURR:AC ", NO_DFLT_PREC, },
123 { SR_MQ_RESISTANCE, 0, "RES", "RES ", NO_DFLT_PREC, },
124 { SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "FRES ", NO_DFLT_PREC, },
125 { SR_MQ_CONTINUITY, 0, "CONT", "CONT", -1, },
126 { SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "DIOD", -4, },
127 { SR_MQ_FREQUENCY, 0, "FREQ", "FREQ ", NO_DFLT_PREC, },
128 { SR_MQ_TIME, 0, "PER", "PER ", NO_DFLT_PREC, },
131 static const struct mqopt_item mqopts_gwinstek_gdm8200a[] = {
132 { SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "01", NO_DFLT_PREC, },
133 { SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "02", NO_DFLT_PREC, },
134 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "03", NO_DFLT_PREC, },
135 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "04", NO_DFLT_PREC, },
136 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "05", NO_DFLT_PREC, }, /* mA */
137 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "06", NO_DFLT_PREC, }, /* mA */
138 { SR_MQ_RESISTANCE, 0, "RES", "07", NO_DFLT_PREC, },
139 { SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "16", NO_DFLT_PREC, },
140 { SR_MQ_CONTINUITY, 0, "CONT", "13", -1, },
141 { SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "17", -4, },
142 { SR_MQ_TEMPERATURE, 0, "TEMP", "09", NO_DFLT_PREC, }, /* Celsius */
143 { SR_MQ_TEMPERATURE, 0, "TEMP", "15", NO_DFLT_PREC, }, /* Fahrenheit */
144 { SR_MQ_FREQUENCY, 0, "FREQ", "08", NO_DFLT_PREC, },
145 { SR_MQ_TIME, 0, "PER", "14", NO_DFLT_PREC, },
148 static const struct mqopt_item mqopts_gwinstek_gdm906x[] = {
149 { SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "VOLT ", NO_DFLT_PREC, },
150 { SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "VOLT:AC", NO_DFLT_PREC, },
151 { SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "CURR ", NO_DFLT_PREC, },
152 { SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "CURR:AC", NO_DFLT_PREC, },
153 { SR_MQ_RESISTANCE, 0, "RES", "RES", NO_DFLT_PREC, },
154 { SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "FRES", NO_DFLT_PREC, },
155 { SR_MQ_CONTINUITY, 0, "CONT", "CONT", -1, },
156 { SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "DIOD", -4, },
157 { SR_MQ_TEMPERATURE, 0, "TEMP", "TEMP", NO_DFLT_PREC, },
158 { SR_MQ_FREQUENCY, 0, "FREQ", "FREQ", NO_DFLT_PREC, },
159 { SR_MQ_TIME, 0, "PER", "PER", NO_DFLT_PREC, },
160 { SR_MQ_CAPACITANCE, 0, "CAP", "CAP", NO_DFLT_PREC, },
163 SR_PRIV const struct scpi_dmm_model models[] = {
166 1, 5, cmdset_agilent, ARRAY_AND_SIZE(mqopts_agilent_34405a),
167 scpi_dmm_get_meas_agilent,
168 ARRAY_AND_SIZE(devopts_generic),
173 1, 6, cmdset_hp, ARRAY_AND_SIZE(mqopts_agilent_34405a),
174 scpi_dmm_get_meas_agilent,
175 ARRAY_AND_SIZE(devopts_generic),
179 "Keysight", "34465A",
180 1, 5, cmdset_agilent, ARRAY_AND_SIZE(mqopts_agilent_34405a),
181 scpi_dmm_get_meas_agilent,
182 ARRAY_AND_SIZE(devopts_generic),
187 1, 6, cmdset_hp, ARRAY_AND_SIZE(mqopts_agilent_34401a),
188 scpi_dmm_get_meas_agilent,
189 ARRAY_AND_SIZE(devopts_generic),
190 /* 34401A: typ. 1020ms for AC readings (default is 1000ms). */
195 1, 6, cmdset_gwinstek, ARRAY_AND_SIZE(mqopts_gwinstek_gdm8200a),
196 scpi_dmm_get_meas_gwinstek,
197 ARRAY_AND_SIZE(devopts_generic),
202 1, 6, cmdset_gwinstek, ARRAY_AND_SIZE(mqopts_gwinstek_gdm8200a),
203 scpi_dmm_get_meas_gwinstek,
204 ARRAY_AND_SIZE(devopts_generic),
208 "GWInstek", "GDM9060",
209 1, 6, cmdset_gwinstek_906x, ARRAY_AND_SIZE(mqopts_gwinstek_gdm906x),
210 scpi_dmm_get_meas_agilent,
211 ARRAY_AND_SIZE(devopts_generic),
215 "GWInstek", "GDM9061",
216 1, 6, cmdset_gwinstek_906x, ARRAY_AND_SIZE(mqopts_gwinstek_gdm906x),
217 scpi_dmm_get_meas_agilent,
218 ARRAY_AND_SIZE(devopts_generic),
223 static const struct scpi_dmm_model *is_compatible(const char *vendor, const char *model)
226 const struct scpi_dmm_model *entry;
228 for (i = 0; i < ARRAY_SIZE(models); i++) {
230 if (!entry->vendor || !entry->model)
232 if (strcmp(vendor, entry->vendor) != 0)
234 if (strcmp(model, entry->model) != 0)
242 static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
244 struct sr_scpi_hw_info *hw_info;
247 const struct scpi_dmm_model *model;
248 struct sr_dev_inst *sdi;
249 struct dev_context *devc;
253 scpi_dmm_cmd_delay(scpi);
254 ret = sr_scpi_get_hw_id(scpi, &hw_info);
256 sr_info("Could not get IDN response.");
259 vendor = sr_vendor_alias(hw_info->manufacturer);
260 model = is_compatible(vendor, hw_info->model);
262 sr_scpi_hw_info_free(hw_info);
266 sdi = g_malloc0(sizeof(*sdi));
267 sdi->vendor = g_strdup(hw_info->manufacturer);
268 sdi->model = g_strdup(hw_info->model);
269 sdi->version = g_strdup(hw_info->firmware_version);
270 sdi->serial_num = g_strdup(hw_info->serial_number);
272 sdi->driver = &scpi_dmm_driver_info;
273 sdi->inst_type = SR_INST_SCPI;
274 sr_scpi_hw_info_free(hw_info);
275 if (model->read_timeout_us) /* non-default read timeout */
276 scpi->read_timeout_us = model->read_timeout_us;
277 devc = g_malloc0(sizeof(*devc));
279 devc->num_channels = model->num_channels;
280 devc->cmdset = model->cmdset;
282 devc->precision = NULL;
284 for (i = 0; i < devc->num_channels; i++) {
285 channel_name = g_strdup_printf("P%zu", i + 1);
286 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, channel_name);
292 static GSList *scan(struct sr_dev_driver *di, GSList *options)
294 return sr_scpi_scan(di->context, options, probe_device);
297 static int dev_open(struct sr_dev_inst *sdi)
299 struct sr_scpi_dev_inst *scpi;
303 ret = sr_scpi_open(scpi);
305 sr_err("Failed to open SCPI device: %s.", sr_strerror(ret));
312 static int dev_close(struct sr_dev_inst *sdi)
314 struct sr_scpi_dev_inst *scpi;
320 sr_dbg("DIAG: sdi->status %d.", sdi->status - SR_ST_NOT_FOUND);
321 if (sdi->status <= SR_ST_INACTIVE)
324 return sr_scpi_close(scpi);
327 static int config_get(uint32_t key, GVariant **data,
328 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
330 struct dev_context *devc;
332 enum sr_mqflag mqflag;
341 case SR_CONF_LIMIT_SAMPLES:
342 case SR_CONF_LIMIT_MSEC:
343 return sr_sw_limits_config_get(&devc->limits, key, data);
344 case SR_CONF_MEASURED_QUANTITY:
345 ret = scpi_dmm_get_mq(sdi, &mq, &mqflag, NULL, NULL);
348 arr[0] = g_variant_new_uint32(mq);
349 arr[1] = g_variant_new_uint64(mqflag);
350 *data = g_variant_new_tuple(arr, ARRAY_SIZE(arr));
357 static int config_set(uint32_t key, GVariant *data,
358 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
360 struct dev_context *devc;
362 enum sr_mqflag mqflag;
363 GVariant *tuple_child;
370 case SR_CONF_LIMIT_SAMPLES:
371 case SR_CONF_LIMIT_MSEC:
372 return sr_sw_limits_config_set(&devc->limits, key, data);
373 case SR_CONF_MEASURED_QUANTITY:
374 tuple_child = g_variant_get_child_value(data, 0);
375 mq = g_variant_get_uint32(tuple_child);
376 g_variant_unref(tuple_child);
377 tuple_child = g_variant_get_child_value(data, 1);
378 mqflag = g_variant_get_uint64(tuple_child);
379 g_variant_unref(tuple_child);
380 return scpi_dmm_set_mq(sdi, mq, mqflag);
386 static int config_list(uint32_t key, GVariant **data,
387 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
389 struct dev_context *devc;
390 GVariant *gvar, *arr[2];
396 devc = sdi ? sdi->priv : NULL;
399 case SR_CONF_SCAN_OPTIONS:
400 case SR_CONF_DEVICE_OPTIONS:
402 return STD_CONFIG_LIST(key, data, sdi, cg,
403 scanopts, drvopts, devopts_generic);
404 return std_opts_config_list(key, data, sdi, cg,
405 ARRAY_AND_SIZE(scanopts), ARRAY_AND_SIZE(drvopts),
406 devc->model->devopts, devc->model->devopts_size);
407 case SR_CONF_MEASURED_QUANTITY:
408 /* TODO Use std_gvar_measured_quantities() when available. */
411 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
412 for (i = 0; i < devc->model->mqopt_size; i++) {
413 arr[0] = g_variant_new_uint32(devc->model->mqopts[i].mq);
414 arr[1] = g_variant_new_uint64(devc->model->mqopts[i].mqflag);
415 gvar = g_variant_new_tuple(arr, ARRAY_SIZE(arr));
416 g_variant_builder_add_value(&gvb, gvar);
418 *data = g_variant_builder_end(&gvb);
426 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
428 struct sr_scpi_dev_inst *scpi;
429 struct dev_context *devc;
431 const struct mqopt_item *item;
438 ret = scpi_dmm_get_mq(sdi, &devc->start_acq_mq.curr_mq,
439 &devc->start_acq_mq.curr_mqflag, NULL, &item);
444 * Query for current precision if DMM supports the command
446 command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_QUERY_PREC);
447 if (command && *command) {
448 scpi_dmm_cmd_delay(scpi);
449 ret = sr_scpi_get_string(scpi, command, &response);
451 g_strstrip(response);
453 g_free(devc->precision);
454 devc->precision=g_strdup(response);
456 sr_dbg("%s: Precision: '%s'", __func__, devc->precision);
458 sr_info("%s: Precision query ('%s') failed: %d",
459 __func__, command, ret);
463 command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_START_ACQ);
464 if (command && *command) {
465 scpi_dmm_cmd_delay(scpi);
466 ret = sr_scpi_send(scpi, command);
471 sr_sw_limits_acquisition_start(&devc->limits);
472 ret = std_session_send_df_header(sdi);
476 ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
477 scpi_dmm_receive_data, (void *)sdi);
484 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
486 struct sr_scpi_dev_inst *scpi;
487 struct dev_context *devc;
493 command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_STOP_ACQ);
494 if (command && *command) {
495 scpi_dmm_cmd_delay(scpi);
496 (void)sr_scpi_send(scpi, command);
498 sr_scpi_source_remove(sdi->session, scpi);
500 std_session_send_df_end(sdi);
502 if (devc->precision) {
503 g_free(devc->precision);
504 devc->precision = NULL;
510 static struct sr_dev_driver scpi_dmm_driver_info = {
512 .longname = "SCPI DMM",
515 .cleanup = std_cleanup,
517 .dev_list = std_dev_list,
518 .dev_clear = std_dev_clear,
519 .config_get = config_get,
520 .config_set = config_set,
521 .config_list = config_list,
522 .dev_open = dev_open,
523 .dev_close = dev_close,
524 .dev_acquisition_start = dev_acquisition_start,
525 .dev_acquisition_stop = dev_acquisition_stop,
528 SR_REGISTER_DEV_DRIVER(scpi_dmm_driver_info);