]> sigrok.org Git - libsigrok.git/blame - src/hardware/hp-3478a/api.c
hp-3478a: Fix switching from 4-wire to 2-wire measurement.
[libsigrok.git] / src / hardware / hp-3478a / api.c
CommitLineData
1d9eebf4
FS
1/*
2 * This file is part of the libsigrok project.
3 *
569165c0 4 * Copyright (C) 2017-2021 Frank Stettner <frank-stettner@gmx.net>
1d9eebf4
FS
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
20#include <config.h>
d2c1730a 21#include "scpi.h"
1d9eebf4
FS
22#include "protocol.h"
23
d2c1730a
FS
24static const uint32_t scanopts[] = {
25 SR_CONF_CONN,
26};
27
28static const uint32_t drvopts[] = {
29 SR_CONF_MULTIMETER,
30};
31
32static const uint32_t devopts[] = {
33 SR_CONF_CONTINUOUS,
34 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
35 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
36 SR_CONF_MEASURED_QUANTITY | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
e5137b93 37 SR_CONF_RANGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
7812a5c8 38 SR_CONF_DIGITS | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
d2c1730a
FS
39};
40
41static const struct {
42 enum sr_mq mq;
43 enum sr_mqflag mqflag;
44} mqopts[] = {
45 {SR_MQ_VOLTAGE, SR_MQFLAG_DC},
e5137b93 46 {SR_MQ_VOLTAGE, SR_MQFLAG_AC},
d2c1730a 47 {SR_MQ_CURRENT, SR_MQFLAG_DC},
e5137b93 48 {SR_MQ_CURRENT, SR_MQFLAG_AC},
d2c1730a 49 {SR_MQ_RESISTANCE, 0},
d2c1730a 50 {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE},
e5137b93
FS
51};
52
e5137b93
FS
53static const struct {
54 enum sr_mq mq;
55 enum sr_mqflag mqflag;
56 int range_exp;
57 const char *range_str;
58} rangeopts[] = {
59 /* -99 is a dummy exponent for auto ranging. */
60 {SR_MQ_VOLTAGE, SR_MQFLAG_DC, -99, "Auto"},
61 {SR_MQ_VOLTAGE, SR_MQFLAG_DC, -2, "30mV"},
62 {SR_MQ_VOLTAGE, SR_MQFLAG_DC, -1, "300mV"},
63 {SR_MQ_VOLTAGE, SR_MQFLAG_DC, 0, "3V"},
64 {SR_MQ_VOLTAGE, SR_MQFLAG_DC, 1, "30V"},
65 {SR_MQ_VOLTAGE, SR_MQFLAG_DC, 2, "300V"},
66 /* -99 is a dummy exponent for auto ranging. */
67 {SR_MQ_VOLTAGE, SR_MQFLAG_AC, -99, "Auto"},
68 {SR_MQ_VOLTAGE, SR_MQFLAG_AC, -1, "300mV"},
69 {SR_MQ_VOLTAGE, SR_MQFLAG_AC, 0, "3V"},
70 {SR_MQ_VOLTAGE, SR_MQFLAG_AC, 1, "30V"},
71 {SR_MQ_VOLTAGE, SR_MQFLAG_AC, 2, "300V"},
72 /* -99 is a dummy exponent for auto ranging. */
73 {SR_MQ_CURRENT, SR_MQFLAG_DC, -99, "Auto"},
74 {SR_MQ_CURRENT, SR_MQFLAG_DC, -1, "300mV"},
75 {SR_MQ_CURRENT, SR_MQFLAG_DC, 0, "3V"},
76 /* -99 is a dummy exponent for auto ranging. */
77 {SR_MQ_CURRENT, SR_MQFLAG_AC, -99, "Auto"},
78 {SR_MQ_CURRENT, SR_MQFLAG_AC, -1, "300mV"},
79 {SR_MQ_CURRENT, SR_MQFLAG_AC, 0, "3V"},
80 /* -99 is a dummy exponent for auto ranging. */
81 {SR_MQ_RESISTANCE, 0, -99, "Auto"},
82 {SR_MQ_RESISTANCE, 0, 1, "30"},
83 {SR_MQ_RESISTANCE, 0, 2, "300"},
84 {SR_MQ_RESISTANCE, 0, 3, "3k"},
85 {SR_MQ_RESISTANCE, 0, 4, "30k"},
86 {SR_MQ_RESISTANCE, 0, 5, "300k"},
87 {SR_MQ_RESISTANCE, 0, 6, "3M"},
88 {SR_MQ_RESISTANCE, 0, 7, "30M"},
89 /* -99 is a dummy exponent for auto ranging. */
90 {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, -99, "Auto"},
91 {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, 1, "30R"},
92 {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, 2, "300R"},
93 {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, 3, "3kR"},
94 {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, 4, "30kR"},
95 {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, 5, "300kR"},
96 {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, 6, "3MR"},
97 {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, 7, "30MR"},
d2c1730a
FS
98};
99
7812a5c8
FS
100/** Available digits as strings. */
101static const char *digits[] = {
102 "3.5", "4.5", "5.5",
103};
104
105/** Mapping between devc->spec_digits and digits string. */
106static const char *digits_map[] = {
107 "", "", "", "", "3.5", "4.5", "5.5",
108};
109
3f34a402 110static struct sr_dev_driver hp_3478a_driver_info;
d2c1730a
FS
111
112static int create_front_channel(struct sr_dev_inst *sdi, int chan_idx)
1d9eebf4 113{
d2c1730a
FS
114 struct sr_channel *channel;
115 struct channel_context *chanc;
1d9eebf4 116
d2c1730a
FS
117 chanc = g_malloc(sizeof(*chanc));
118 chanc->location = TERMINAL_FRONT;
1d9eebf4 119
d2c1730a
FS
120 channel = sr_channel_new(sdi, chan_idx++, SR_CHANNEL_ANALOG, TRUE, "P1");
121 channel->priv = chanc;
1d9eebf4 122
d2c1730a
FS
123 return chan_idx;
124}
1d9eebf4 125
d2c1730a
FS
126static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
127{
128 int ret;
129 struct sr_dev_inst *sdi;
130 struct dev_context *devc;
131
8ef4fb33
FS
132 /*
133 * The device cannot get identified by means of SCPI queries.
134 * Neither shall non-SCPI requests get emitted before reliable
135 * identification of the device. Assume that we only get here
136 * when user specs led us to believe it's safe to communicate
137 * to the expected kind of device.
138 */
139
d2c1730a
FS
140 sdi = g_malloc0(sizeof(struct sr_dev_inst));
141 sdi->vendor = g_strdup("Hewlett-Packard");
142 sdi->model = g_strdup("3478A");
143 sdi->conn = scpi;
144 sdi->driver = &hp_3478a_driver_info;
145 sdi->inst_type = SR_INST_SCPI;
146
147 devc = g_malloc0(sizeof(struct dev_context));
148 sr_sw_limits_init(&devc->limits);
149 sdi->priv = devc;
150
151 /* Get actual status (function, digits, ...). */
152 ret = hp_3478a_get_status_bytes(sdi);
153 if (ret != SR_OK)
154 return NULL;
155
156 create_front_channel(sdi, 0);
157
158 return sdi;
159}
160
161static GSList *scan(struct sr_dev_driver *di, GSList *options)
162{
8ef4fb33
FS
163 const char *conn;
164
165 /* Only scan for a device when conn= was specified. */
166 conn = NULL;
167 (void)sr_serial_extract_options(options, &conn, NULL);
168 if (!conn)
169 return NULL;
170
d2c1730a 171 return sr_scpi_scan(di->context, options, probe_device);
1d9eebf4
FS
172}
173
174static int dev_open(struct sr_dev_inst *sdi)
175{
04c4a677 176 return sr_scpi_open(sdi->conn);
1d9eebf4
FS
177}
178
179static int dev_close(struct sr_dev_inst *sdi)
180{
04c4a677 181 return sr_scpi_close(sdi->conn);
1d9eebf4
FS
182}
183
184static int config_get(uint32_t key, GVariant **data,
185 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
186{
d2c1730a 187 struct dev_context *devc;
1d9eebf4 188 int ret;
d2c1730a 189 GVariant *arr[2];
e5137b93
FS
190 unsigned int i;
191 const char *range_str;
1d9eebf4 192
1d9eebf4
FS
193 (void)cg;
194
020df861 195 devc = sdi ? sdi->priv : NULL;
d2c1730a 196
1d9eebf4 197 switch (key) {
d2c1730a
FS
198 case SR_CONF_LIMIT_SAMPLES:
199 case SR_CONF_LIMIT_MSEC:
200 return sr_sw_limits_config_get(&devc->limits, key, data);
201 case SR_CONF_MEASURED_QUANTITY:
202 ret = hp_3478a_get_status_bytes(sdi);
203 if (ret != SR_OK)
204 return ret;
205 arr[0] = g_variant_new_uint32(devc->measurement_mq);
569165c0 206 arr[1] = g_variant_new_uint64(devc->measurement_mq_flag);
d2c1730a
FS
207 *data = g_variant_new_tuple(arr, 2);
208 break;
e5137b93
FS
209 case SR_CONF_RANGE:
210 ret = hp_3478a_get_status_bytes(sdi);
211 if (ret != SR_OK)
212 return ret;
213 range_str = "Auto";
214 for (i = 0; i < ARRAY_SIZE(rangeopts); i++) {
215 if (rangeopts[i].mq == devc->measurement_mq &&
569165c0 216 rangeopts[i].mqflag == devc->measurement_mq_flag &&
e5137b93
FS
217 rangeopts[i].range_exp == devc->range_exp) {
218 range_str = rangeopts[i].range_str;
219 break;
220 }
221 }
222 *data = g_variant_new_string(range_str);
223 break;
7812a5c8
FS
224 case SR_CONF_DIGITS:
225 ret = hp_3478a_get_status_bytes(sdi);
226 if (ret != SR_OK)
227 return ret;
228 *data = g_variant_new_string(digits_map[devc->spec_digits]);
229 break;
1d9eebf4
FS
230 default:
231 return SR_ERR_NA;
232 }
233
d2c1730a 234 return SR_OK;
1d9eebf4
FS
235}
236
237static int config_set(uint32_t key, GVariant *data,
238 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
239{
d2c1730a
FS
240 struct dev_context *devc;
241 enum sr_mq mq;
242 enum sr_mqflag mq_flags;
243 GVariant *tuple_child;
e5137b93
FS
244 unsigned int i;
245 const char *range_str;
7812a5c8 246 const char *digits_str;
1d9eebf4 247
1d9eebf4
FS
248 (void)cg;
249
020df861 250 devc = sdi ? sdi->priv : NULL;
d2c1730a 251
1d9eebf4 252 switch (key) {
d2c1730a
FS
253 case SR_CONF_LIMIT_SAMPLES:
254 case SR_CONF_LIMIT_MSEC:
255 return sr_sw_limits_config_set(&devc->limits, key, data);
256 case SR_CONF_MEASURED_QUANTITY:
257 tuple_child = g_variant_get_child_value(data, 0);
258 mq = g_variant_get_uint32(tuple_child);
883db4da 259 g_variant_unref(tuple_child);
d2c1730a
FS
260 tuple_child = g_variant_get_child_value(data, 1);
261 mq_flags = g_variant_get_uint64(tuple_child);
262 g_variant_unref(tuple_child);
263 return hp_3478a_set_mq(sdi, mq, mq_flags);
e5137b93
FS
264 case SR_CONF_RANGE:
265 range_str = g_variant_get_string(data, NULL);
266 for (i = 0; i < ARRAY_SIZE(rangeopts); i++) {
267 if (rangeopts[i].mq == devc->measurement_mq &&
569165c0 268 rangeopts[i].mqflag == devc->measurement_mq_flag &&
e5137b93
FS
269 g_strcmp0(rangeopts[i].range_str, range_str) == 0) {
270 return hp_3478a_set_range(sdi, rangeopts[i].range_exp);
271 }
272 }
273 return SR_ERR_NA;
7812a5c8
FS
274 case SR_CONF_DIGITS:
275 digits_str = g_variant_get_string(data, NULL);
276 for (i = 0; i < ARRAY_SIZE(rangeopts); i++) {
277 if (g_strcmp0(digits_map[i], digits_str) == 0)
278 return hp_3478a_set_digits(sdi, i);
279 }
280 return SR_ERR_NA;
1d9eebf4 281 default:
d2c1730a 282 return SR_ERR_NA;
1d9eebf4
FS
283 }
284
d2c1730a 285 return SR_OK;
1d9eebf4
FS
286}
287
288static int config_list(uint32_t key, GVariant **data,
289 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
290{
e5137b93
FS
291 struct dev_context *devc;
292 int ret;
d2c1730a
FS
293 unsigned int i;
294 GVariant *gvar, *arr[2];
295 GVariantBuilder gvb;
1d9eebf4 296
020df861 297 devc = sdi ? sdi->priv : NULL;
e5137b93 298
1d9eebf4 299 switch (key) {
d2c1730a
FS
300 case SR_CONF_SCAN_OPTIONS:
301 case SR_CONF_DEVICE_OPTIONS:
302 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
303 case SR_CONF_MEASURED_QUANTITY:
304 /*
305 * TODO: move to std.c as
306 * SR_PRIV GVariant *std_gvar_measured_quantities()
307 */
308 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
309 for (i = 0; i < ARRAY_SIZE(mqopts); i++) {
310 arr[0] = g_variant_new_uint32(mqopts[i].mq);
311 arr[1] = g_variant_new_uint64(mqopts[i].mqflag);
312 gvar = g_variant_new_tuple(arr, 2);
313 g_variant_builder_add_value(&gvb, gvar);
314 }
315 *data = g_variant_builder_end(&gvb);
316 break;
e5137b93
FS
317 case SR_CONF_RANGE:
318 ret = hp_3478a_get_status_bytes(sdi);
319 if (ret != SR_OK)
320 return ret;
321 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
322 for (i = 0; i < ARRAY_SIZE(rangeopts); i++) {
323 if (rangeopts[i].mq == devc->measurement_mq &&
569165c0 324 rangeopts[i].mqflag == devc->measurement_mq_flag) {
e5137b93
FS
325 g_variant_builder_add(&gvb, "s", rangeopts[i].range_str);
326 }
327 }
328 *data = g_variant_builder_end(&gvb);
329 break;
7812a5c8
FS
330 case SR_CONF_DIGITS:
331 *data = g_variant_new_strv(ARRAY_AND_SIZE(digits));
332 break;
1d9eebf4
FS
333 default:
334 return SR_ERR_NA;
335 }
336
d2c1730a 337 return SR_OK;
1d9eebf4
FS
338}
339
340static int dev_acquisition_start(const struct sr_dev_inst *sdi)
341{
d2c1730a
FS
342 struct sr_scpi_dev_inst *scpi;
343 struct dev_context *devc;
344
345 scpi = sdi->conn;
346 devc = sdi->priv;
1d9eebf4 347
d2c1730a
FS
348 sr_sw_limits_acquisition_start(&devc->limits);
349 std_session_send_df_header(sdi);
350
351 /*
352 * NOTE: For faster readings, there are some things one can do:
353 * - Turn off the display: sr_scpi_send(scpi, "D3SIGROK").
354 * - Set the line frequency to 60Hz via switch (back of the unit).
7812a5c8 355 * - Set to 3.5 digits measurement.
d2c1730a
FS
356 */
357
358 /* Set to internal trigger. */
359 sr_scpi_send(scpi, "T1");
360 /* Get device status. */
361 hp_3478a_get_status_bytes(sdi);
362
04c4a677 363 return sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 100,
d2c1730a 364 hp_3478a_receive_data, (void *)sdi);
1d9eebf4
FS
365}
366
367static int dev_acquisition_stop(struct sr_dev_inst *sdi)
368{
d2c1730a
FS
369 struct sr_scpi_dev_inst *scpi;
370
371 scpi = sdi->conn;
372
373 sr_scpi_source_remove(sdi->session, scpi);
374 std_session_send_df_end(sdi);
1d9eebf4 375
d2c1730a
FS
376 /* Set to internal trigger. */
377 sr_scpi_send(scpi, "T1");
378 /* Turn on display. */
379 sr_scpi_send(scpi, "D1");
1d9eebf4
FS
380
381 return SR_OK;
382}
383
3f34a402 384static struct sr_dev_driver hp_3478a_driver_info = {
1d9eebf4
FS
385 .name = "hp-3478a",
386 .longname = "HP 3478A",
387 .api_version = 1,
388 .init = std_init,
389 .cleanup = std_cleanup,
390 .scan = scan,
391 .dev_list = std_dev_list,
392 .dev_clear = std_dev_clear,
393 .config_get = config_get,
394 .config_set = config_set,
395 .config_list = config_list,
396 .dev_open = dev_open,
397 .dev_close = dev_close,
398 .dev_acquisition_start = dev_acquisition_start,
399 .dev_acquisition_stop = dev_acquisition_stop,
400 .context = NULL,
401};
1d9eebf4 402SR_REGISTER_DEV_DRIVER(hp_3478a_driver_info);