]> sigrok.org Git - libsigrok.git/blame - src/hardware/hp-3478a/api.c
hp-3478a: Add get/set/list of digits.
[libsigrok.git] / src / hardware / hp-3478a / api.c
CommitLineData
1d9eebf4
FS
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2017 Frank Stettner <frank-stettner@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
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
132 sdi = g_malloc0(sizeof(struct sr_dev_inst));
133 sdi->vendor = g_strdup("Hewlett-Packard");
134 sdi->model = g_strdup("3478A");
135 sdi->conn = scpi;
136 sdi->driver = &hp_3478a_driver_info;
137 sdi->inst_type = SR_INST_SCPI;
138
139 devc = g_malloc0(sizeof(struct dev_context));
140 sr_sw_limits_init(&devc->limits);
141 sdi->priv = devc;
142
143 /* Get actual status (function, digits, ...). */
144 ret = hp_3478a_get_status_bytes(sdi);
145 if (ret != SR_OK)
146 return NULL;
147
148 create_front_channel(sdi, 0);
149
150 return sdi;
151}
152
153static GSList *scan(struct sr_dev_driver *di, GSList *options)
154{
155 return sr_scpi_scan(di->context, options, probe_device);
1d9eebf4
FS
156}
157
158static int dev_open(struct sr_dev_inst *sdi)
159{
04c4a677 160 return sr_scpi_open(sdi->conn);
1d9eebf4
FS
161}
162
163static int dev_close(struct sr_dev_inst *sdi)
164{
04c4a677 165 return sr_scpi_close(sdi->conn);
1d9eebf4
FS
166}
167
168static int config_get(uint32_t key, GVariant **data,
169 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
170{
d2c1730a 171 struct dev_context *devc;
1d9eebf4 172 int ret;
d2c1730a 173 GVariant *arr[2];
e5137b93
FS
174 unsigned int i;
175 const char *range_str;
1d9eebf4 176
1d9eebf4
FS
177 (void)cg;
178
d2c1730a
FS
179 devc = sdi->priv;
180
1d9eebf4 181 switch (key) {
d2c1730a
FS
182 case SR_CONF_LIMIT_SAMPLES:
183 case SR_CONF_LIMIT_MSEC:
184 return sr_sw_limits_config_get(&devc->limits, key, data);
185 case SR_CONF_MEASURED_QUANTITY:
186 ret = hp_3478a_get_status_bytes(sdi);
187 if (ret != SR_OK)
188 return ret;
189 arr[0] = g_variant_new_uint32(devc->measurement_mq);
190 arr[1] = g_variant_new_uint64(devc->measurement_mq_flags);
191 *data = g_variant_new_tuple(arr, 2);
192 break;
e5137b93
FS
193 case SR_CONF_RANGE:
194 ret = hp_3478a_get_status_bytes(sdi);
195 if (ret != SR_OK)
196 return ret;
197 range_str = "Auto";
198 for (i = 0; i < ARRAY_SIZE(rangeopts); i++) {
199 if (rangeopts[i].mq == devc->measurement_mq &&
200 rangeopts[i].mqflag == devc->measurement_mq_flags &&
201 rangeopts[i].range_exp == devc->range_exp) {
202 range_str = rangeopts[i].range_str;
203 break;
204 }
205 }
206 *data = g_variant_new_string(range_str);
207 break;
7812a5c8
FS
208 case SR_CONF_DIGITS:
209 ret = hp_3478a_get_status_bytes(sdi);
210 if (ret != SR_OK)
211 return ret;
212 *data = g_variant_new_string(digits_map[devc->spec_digits]);
213 break;
1d9eebf4
FS
214 default:
215 return SR_ERR_NA;
216 }
217
d2c1730a 218 return SR_OK;
1d9eebf4
FS
219}
220
221static int config_set(uint32_t key, GVariant *data,
222 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
223{
d2c1730a
FS
224 struct dev_context *devc;
225 enum sr_mq mq;
226 enum sr_mqflag mq_flags;
227 GVariant *tuple_child;
e5137b93
FS
228 unsigned int i;
229 const char *range_str;
7812a5c8 230 const char *digits_str;
1d9eebf4 231
1d9eebf4
FS
232 (void)cg;
233
d2c1730a
FS
234 devc = sdi->priv;
235
1d9eebf4 236 switch (key) {
d2c1730a
FS
237 case SR_CONF_LIMIT_SAMPLES:
238 case SR_CONF_LIMIT_MSEC:
239 return sr_sw_limits_config_set(&devc->limits, key, data);
240 case SR_CONF_MEASURED_QUANTITY:
241 tuple_child = g_variant_get_child_value(data, 0);
242 mq = g_variant_get_uint32(tuple_child);
243 tuple_child = g_variant_get_child_value(data, 1);
244 mq_flags = g_variant_get_uint64(tuple_child);
245 g_variant_unref(tuple_child);
246 return hp_3478a_set_mq(sdi, mq, mq_flags);
e5137b93
FS
247 case SR_CONF_RANGE:
248 range_str = g_variant_get_string(data, NULL);
249 for (i = 0; i < ARRAY_SIZE(rangeopts); i++) {
250 if (rangeopts[i].mq == devc->measurement_mq &&
251 rangeopts[i].mqflag == devc->measurement_mq_flags &&
252 g_strcmp0(rangeopts[i].range_str, range_str) == 0) {
253 return hp_3478a_set_range(sdi, rangeopts[i].range_exp);
254 }
255 }
256 return SR_ERR_NA;
7812a5c8
FS
257 case SR_CONF_DIGITS:
258 digits_str = g_variant_get_string(data, NULL);
259 for (i = 0; i < ARRAY_SIZE(rangeopts); i++) {
260 if (g_strcmp0(digits_map[i], digits_str) == 0)
261 return hp_3478a_set_digits(sdi, i);
262 }
263 return SR_ERR_NA;
1d9eebf4 264 default:
d2c1730a 265 return SR_ERR_NA;
1d9eebf4
FS
266 }
267
d2c1730a 268 return SR_OK;
1d9eebf4
FS
269}
270
271static int config_list(uint32_t key, GVariant **data,
272 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
273{
e5137b93
FS
274 struct dev_context *devc;
275 int ret;
d2c1730a
FS
276 unsigned int i;
277 GVariant *gvar, *arr[2];
278 GVariantBuilder gvb;
1d9eebf4 279
e5137b93
FS
280 devc = sdi->priv;
281
1d9eebf4 282 switch (key) {
d2c1730a
FS
283 case SR_CONF_SCAN_OPTIONS:
284 case SR_CONF_DEVICE_OPTIONS:
285 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
286 case SR_CONF_MEASURED_QUANTITY:
287 /*
288 * TODO: move to std.c as
289 * SR_PRIV GVariant *std_gvar_measured_quantities()
290 */
291 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
292 for (i = 0; i < ARRAY_SIZE(mqopts); i++) {
293 arr[0] = g_variant_new_uint32(mqopts[i].mq);
294 arr[1] = g_variant_new_uint64(mqopts[i].mqflag);
295 gvar = g_variant_new_tuple(arr, 2);
296 g_variant_builder_add_value(&gvb, gvar);
297 }
298 *data = g_variant_builder_end(&gvb);
299 break;
e5137b93
FS
300 case SR_CONF_RANGE:
301 ret = hp_3478a_get_status_bytes(sdi);
302 if (ret != SR_OK)
303 return ret;
304 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
305 for (i = 0; i < ARRAY_SIZE(rangeopts); i++) {
306 if (rangeopts[i].mq == devc->measurement_mq &&
307 rangeopts[i].mqflag == devc->measurement_mq_flags) {
308 g_variant_builder_add(&gvb, "s", rangeopts[i].range_str);
309 }
310 }
311 *data = g_variant_builder_end(&gvb);
312 break;
7812a5c8
FS
313 case SR_CONF_DIGITS:
314 *data = g_variant_new_strv(ARRAY_AND_SIZE(digits));
315 break;
1d9eebf4
FS
316 default:
317 return SR_ERR_NA;
318 }
319
d2c1730a 320 return SR_OK;
1d9eebf4
FS
321}
322
323static int dev_acquisition_start(const struct sr_dev_inst *sdi)
324{
d2c1730a
FS
325 struct sr_scpi_dev_inst *scpi;
326 struct dev_context *devc;
327
328 scpi = sdi->conn;
329 devc = sdi->priv;
1d9eebf4 330
d2c1730a
FS
331 sr_sw_limits_acquisition_start(&devc->limits);
332 std_session_send_df_header(sdi);
333
334 /*
335 * NOTE: For faster readings, there are some things one can do:
336 * - Turn off the display: sr_scpi_send(scpi, "D3SIGROK").
337 * - Set the line frequency to 60Hz via switch (back of the unit).
7812a5c8 338 * - Set to 3.5 digits measurement.
d2c1730a
FS
339 */
340
341 /* Set to internal trigger. */
342 sr_scpi_send(scpi, "T1");
343 /* Get device status. */
344 hp_3478a_get_status_bytes(sdi);
345
04c4a677 346 return sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 100,
d2c1730a 347 hp_3478a_receive_data, (void *)sdi);
1d9eebf4
FS
348}
349
350static int dev_acquisition_stop(struct sr_dev_inst *sdi)
351{
d2c1730a
FS
352 struct sr_scpi_dev_inst *scpi;
353
354 scpi = sdi->conn;
355
356 sr_scpi_source_remove(sdi->session, scpi);
357 std_session_send_df_end(sdi);
1d9eebf4 358
d2c1730a
FS
359 /* Set to internal trigger. */
360 sr_scpi_send(scpi, "T1");
361 /* Turn on display. */
362 sr_scpi_send(scpi, "D1");
1d9eebf4
FS
363
364 return SR_OK;
365}
366
3f34a402 367static struct sr_dev_driver hp_3478a_driver_info = {
1d9eebf4
FS
368 .name = "hp-3478a",
369 .longname = "HP 3478A",
370 .api_version = 1,
371 .init = std_init,
372 .cleanup = std_cleanup,
373 .scan = scan,
374 .dev_list = std_dev_list,
375 .dev_clear = std_dev_clear,
376 .config_get = config_get,
377 .config_set = config_set,
378 .config_list = config_list,
379 .dev_open = dev_open,
380 .dev_close = dev_close,
381 .dev_acquisition_start = dev_acquisition_start,
382 .dev_acquisition_stop = dev_acquisition_stop,
383 .context = NULL,
384};
1d9eebf4 385SR_REGISTER_DEV_DRIVER(hp_3478a_driver_info);