]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2017-2021 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> | |
21 | #include "scpi.h" | |
22 | #include "protocol.h" | |
23 | ||
24 | static const uint32_t scanopts[] = { | |
25 | SR_CONF_CONN, | |
26 | }; | |
27 | ||
28 | static const uint32_t drvopts[] = { | |
29 | SR_CONF_MULTIMETER, | |
30 | }; | |
31 | ||
32 | static 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, | |
37 | SR_CONF_RANGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
38 | SR_CONF_DIGITS | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
39 | }; | |
40 | ||
41 | static const struct { | |
42 | enum sr_mq mq; | |
43 | enum sr_mqflag mqflag; | |
44 | } mqopts[] = { | |
45 | {SR_MQ_VOLTAGE, SR_MQFLAG_DC}, | |
46 | {SR_MQ_VOLTAGE, SR_MQFLAG_AC}, | |
47 | {SR_MQ_CURRENT, SR_MQFLAG_DC}, | |
48 | {SR_MQ_CURRENT, SR_MQFLAG_AC}, | |
49 | {SR_MQ_RESISTANCE, 0}, | |
50 | {SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE}, | |
51 | }; | |
52 | ||
53 | static 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, "300mA"}, | |
75 | {SR_MQ_CURRENT, SR_MQFLAG_DC, 0, "3A"}, | |
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, "300mA"}, | |
79 | {SR_MQ_CURRENT, SR_MQFLAG_AC, 0, "3A"}, | |
80 | /* -99 is a dummy exponent for auto ranging. */ | |
81 | {SR_MQ_RESISTANCE, 0, -99, "Auto"}, | |
82 | {SR_MQ_RESISTANCE, 0, 1, "30R"}, | |
83 | {SR_MQ_RESISTANCE, 0, 2, "300R"}, | |
84 | {SR_MQ_RESISTANCE, 0, 3, "3kR"}, | |
85 | {SR_MQ_RESISTANCE, 0, 4, "30kR"}, | |
86 | {SR_MQ_RESISTANCE, 0, 5, "300kR"}, | |
87 | {SR_MQ_RESISTANCE, 0, 6, "3MR"}, | |
88 | {SR_MQ_RESISTANCE, 0, 7, "30MR"}, | |
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"}, | |
98 | }; | |
99 | ||
100 | /** Available digits as strings. */ | |
101 | static const char *digits[] = { | |
102 | "3.5", "4.5", "5.5", | |
103 | }; | |
104 | ||
105 | /** Mapping between devc->digits and digits string. */ | |
106 | static const char *digits_map[] = { | |
107 | "", "", "", "", "3.5", "4.5", "5.5", | |
108 | }; | |
109 | ||
110 | static struct sr_dev_driver hp_3478a_driver_info; | |
111 | ||
112 | static int create_front_channel(struct sr_dev_inst *sdi, int chan_idx) | |
113 | { | |
114 | struct sr_channel *channel; | |
115 | struct channel_context *chanc; | |
116 | ||
117 | chanc = g_malloc(sizeof(*chanc)); | |
118 | chanc->location = TERMINAL_FRONT; | |
119 | ||
120 | channel = sr_channel_new(sdi, chan_idx++, SR_CHANNEL_ANALOG, TRUE, "P1"); | |
121 | channel->priv = chanc; | |
122 | ||
123 | return chan_idx; | |
124 | } | |
125 | ||
126 | static 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 | /* | |
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 | ||
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 | ||
161 | static GSList *scan(struct sr_dev_driver *di, GSList *options) | |
162 | { | |
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 | ||
171 | return sr_scpi_scan(di->context, options, probe_device); | |
172 | } | |
173 | ||
174 | static int dev_open(struct sr_dev_inst *sdi) | |
175 | { | |
176 | return sr_scpi_open(sdi->conn); | |
177 | } | |
178 | ||
179 | static int dev_close(struct sr_dev_inst *sdi) | |
180 | { | |
181 | return sr_scpi_close(sdi->conn); | |
182 | } | |
183 | ||
184 | static int config_get(uint32_t key, GVariant **data, | |
185 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
186 | { | |
187 | struct dev_context *devc; | |
188 | int ret; | |
189 | GVariant *arr[2]; | |
190 | unsigned int i; | |
191 | const char *range_str; | |
192 | ||
193 | (void)cg; | |
194 | ||
195 | if (!sdi) | |
196 | return SR_ERR_ARG; | |
197 | devc = sdi->priv; | |
198 | ||
199 | switch (key) { | |
200 | case SR_CONF_LIMIT_SAMPLES: | |
201 | case SR_CONF_LIMIT_MSEC: | |
202 | return sr_sw_limits_config_get(&devc->limits, key, data); | |
203 | case SR_CONF_MEASURED_QUANTITY: | |
204 | ret = hp_3478a_get_status_bytes(sdi); | |
205 | if (ret != SR_OK) | |
206 | return ret; | |
207 | arr[0] = g_variant_new_uint32(devc->measurement_mq); | |
208 | arr[1] = g_variant_new_uint64(devc->measurement_mq_flag); | |
209 | *data = g_variant_new_tuple(arr, 2); | |
210 | break; | |
211 | case SR_CONF_RANGE: | |
212 | ret = hp_3478a_get_status_bytes(sdi); | |
213 | if (ret != SR_OK) | |
214 | return ret; | |
215 | range_str = "Auto"; | |
216 | for (i = 0; i < ARRAY_SIZE(rangeopts); i++) { | |
217 | if (rangeopts[i].mq == devc->measurement_mq && | |
218 | rangeopts[i].mqflag == devc->measurement_mq_flag && | |
219 | rangeopts[i].range_exp == devc->range_exp) { | |
220 | range_str = rangeopts[i].range_str; | |
221 | break; | |
222 | } | |
223 | } | |
224 | *data = g_variant_new_string(range_str); | |
225 | break; | |
226 | case SR_CONF_DIGITS: | |
227 | ret = hp_3478a_get_status_bytes(sdi); | |
228 | if (ret != SR_OK) | |
229 | return ret; | |
230 | *data = g_variant_new_string(digits_map[devc->digits]); | |
231 | break; | |
232 | default: | |
233 | return SR_ERR_NA; | |
234 | } | |
235 | ||
236 | return SR_OK; | |
237 | } | |
238 | ||
239 | static int config_set(uint32_t key, GVariant *data, | |
240 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
241 | { | |
242 | struct dev_context *devc; | |
243 | enum sr_mq mq; | |
244 | enum sr_mqflag mq_flags; | |
245 | GVariant *tuple_child; | |
246 | unsigned int i; | |
247 | const char *range_str; | |
248 | const char *digits_str; | |
249 | ||
250 | (void)cg; | |
251 | ||
252 | if (!sdi) | |
253 | return SR_ERR_ARG; | |
254 | devc = sdi->priv; | |
255 | ||
256 | switch (key) { | |
257 | case SR_CONF_LIMIT_SAMPLES: | |
258 | case SR_CONF_LIMIT_MSEC: | |
259 | return sr_sw_limits_config_set(&devc->limits, key, data); | |
260 | case SR_CONF_MEASURED_QUANTITY: | |
261 | tuple_child = g_variant_get_child_value(data, 0); | |
262 | mq = g_variant_get_uint32(tuple_child); | |
263 | g_variant_unref(tuple_child); | |
264 | tuple_child = g_variant_get_child_value(data, 1); | |
265 | mq_flags = g_variant_get_uint64(tuple_child); | |
266 | g_variant_unref(tuple_child); | |
267 | return hp_3478a_set_mq(sdi, mq, mq_flags); | |
268 | case SR_CONF_RANGE: | |
269 | range_str = g_variant_get_string(data, NULL); | |
270 | for (i = 0; i < ARRAY_SIZE(rangeopts); i++) { | |
271 | if (rangeopts[i].mq == devc->measurement_mq && | |
272 | rangeopts[i].mqflag == devc->measurement_mq_flag && | |
273 | g_strcmp0(rangeopts[i].range_str, range_str) == 0) { | |
274 | return hp_3478a_set_range(sdi, rangeopts[i].range_exp); | |
275 | } | |
276 | } | |
277 | return SR_ERR_NA; | |
278 | case SR_CONF_DIGITS: | |
279 | digits_str = g_variant_get_string(data, NULL); | |
280 | for (i = 0; i < ARRAY_SIZE(rangeopts); i++) { | |
281 | if (g_strcmp0(digits_map[i], digits_str) == 0) | |
282 | return hp_3478a_set_digits(sdi, i); | |
283 | } | |
284 | return SR_ERR_NA; | |
285 | default: | |
286 | return SR_ERR_NA; | |
287 | } | |
288 | ||
289 | return SR_OK; | |
290 | } | |
291 | ||
292 | static int config_list(uint32_t key, GVariant **data, | |
293 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
294 | { | |
295 | struct dev_context *devc; | |
296 | int ret; | |
297 | unsigned int i; | |
298 | GVariant *gvar, *arr[2]; | |
299 | GVariantBuilder gvb; | |
300 | ||
301 | /* Only handle standard keys when no device instance is given. */ | |
302 | if (!sdi) | |
303 | return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts); | |
304 | ||
305 | devc = sdi->priv; | |
306 | ||
307 | switch (key) { | |
308 | case SR_CONF_SCAN_OPTIONS: | |
309 | case SR_CONF_DEVICE_OPTIONS: | |
310 | return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts); | |
311 | case SR_CONF_MEASURED_QUANTITY: | |
312 | /* | |
313 | * TODO: move to std.c as | |
314 | * SR_PRIV GVariant *std_gvar_measured_quantities() | |
315 | */ | |
316 | g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); | |
317 | for (i = 0; i < ARRAY_SIZE(mqopts); i++) { | |
318 | arr[0] = g_variant_new_uint32(mqopts[i].mq); | |
319 | arr[1] = g_variant_new_uint64(mqopts[i].mqflag); | |
320 | gvar = g_variant_new_tuple(arr, 2); | |
321 | g_variant_builder_add_value(&gvb, gvar); | |
322 | } | |
323 | *data = g_variant_builder_end(&gvb); | |
324 | break; | |
325 | case SR_CONF_RANGE: | |
326 | ret = hp_3478a_get_status_bytes(sdi); | |
327 | if (ret != SR_OK) | |
328 | return ret; | |
329 | g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); | |
330 | for (i = 0; i < ARRAY_SIZE(rangeopts); i++) { | |
331 | if (rangeopts[i].mq == devc->measurement_mq && | |
332 | rangeopts[i].mqflag == devc->measurement_mq_flag) { | |
333 | g_variant_builder_add(&gvb, "s", rangeopts[i].range_str); | |
334 | } | |
335 | } | |
336 | *data = g_variant_builder_end(&gvb); | |
337 | break; | |
338 | case SR_CONF_DIGITS: | |
339 | *data = g_variant_new_strv(ARRAY_AND_SIZE(digits)); | |
340 | break; | |
341 | default: | |
342 | return SR_ERR_NA; | |
343 | } | |
344 | ||
345 | return SR_OK; | |
346 | } | |
347 | ||
348 | static int dev_acquisition_start(const struct sr_dev_inst *sdi) | |
349 | { | |
350 | struct sr_scpi_dev_inst *scpi; | |
351 | struct dev_context *devc; | |
352 | ||
353 | scpi = sdi->conn; | |
354 | devc = sdi->priv; | |
355 | ||
356 | sr_sw_limits_acquisition_start(&devc->limits); | |
357 | std_session_send_df_header(sdi); | |
358 | ||
359 | /* | |
360 | * NOTE: For faster readings, there are some things one can do: | |
361 | * - Turn off the display: sr_scpi_send(scpi, "D3SIGROK"). | |
362 | * - Set the line frequency to 60Hz via switch (back of the unit). | |
363 | * - Set to 3.5 digits measurement. | |
364 | */ | |
365 | ||
366 | /* Set to internal trigger. */ | |
367 | sr_scpi_send(scpi, "T1"); | |
368 | /* Get device status. */ | |
369 | hp_3478a_get_status_bytes(sdi); | |
370 | ||
371 | return sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 100, | |
372 | hp_3478a_receive_data, (void *)sdi); | |
373 | } | |
374 | ||
375 | static int dev_acquisition_stop(struct sr_dev_inst *sdi) | |
376 | { | |
377 | struct sr_scpi_dev_inst *scpi; | |
378 | ||
379 | scpi = sdi->conn; | |
380 | ||
381 | sr_scpi_source_remove(sdi->session, scpi); | |
382 | std_session_send_df_end(sdi); | |
383 | ||
384 | /* Set to internal trigger. */ | |
385 | sr_scpi_send(scpi, "T1"); | |
386 | /* Turn on display. */ | |
387 | sr_scpi_send(scpi, "D1"); | |
388 | ||
389 | return SR_OK; | |
390 | } | |
391 | ||
392 | static struct sr_dev_driver hp_3478a_driver_info = { | |
393 | .name = "hp-3478a", | |
394 | .longname = "HP 3478A", | |
395 | .api_version = 1, | |
396 | .init = std_init, | |
397 | .cleanup = std_cleanup, | |
398 | .scan = scan, | |
399 | .dev_list = std_dev_list, | |
400 | .dev_clear = std_dev_clear, | |
401 | .config_get = config_get, | |
402 | .config_set = config_set, | |
403 | .config_list = config_list, | |
404 | .dev_open = dev_open, | |
405 | .dev_close = dev_close, | |
406 | .dev_acquisition_start = dev_acquisition_start, | |
407 | .dev_acquisition_stop = dev_acquisition_stop, | |
408 | .context = NULL, | |
409 | }; | |
410 | SR_REGISTER_DEV_DRIVER(hp_3478a_driver_info); |