]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2016 Alexandru Gagniuc <mr.nuke.me@gmail.com> | |
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 <string.h> | |
23 | #include "protocol.h" | |
24 | ||
25 | static const uint32_t scanopts[] = { | |
26 | SR_CONF_CONN, | |
27 | }; | |
28 | ||
29 | static const uint32_t drvopts[] = { | |
30 | SR_CONF_MULTIMETER, | |
31 | }; | |
32 | ||
33 | static const uint32_t devopts[] = { | |
34 | SR_CONF_CONTINUOUS | SR_CONF_SET, | |
35 | SR_CONF_LIMIT_SAMPLES | SR_CONF_SET, | |
36 | SR_CONF_MEASURED_QUANTITY | SR_CONF_SET, | |
37 | SR_CONF_ADC_POWERLINE_CYCLES | SR_CONF_SET | SR_CONF_GET, | |
38 | }; | |
39 | ||
40 | SR_PRIV struct sr_dev_driver hp_3457a_driver_info; | |
41 | ||
42 | static int create_front_channel(struct sr_dev_inst *sdi, int chan_idx) | |
43 | { | |
44 | struct sr_channel *channel; | |
45 | struct sr_channel_group *front; | |
46 | struct channel_context *chanc; | |
47 | ||
48 | chanc = g_malloc(sizeof(*chanc)); | |
49 | chanc->location = CONN_FRONT; | |
50 | ||
51 | channel = sr_channel_new(sdi, chan_idx++, SR_CHANNEL_ANALOG, | |
52 | TRUE, "Front"); | |
53 | channel->priv = chanc; | |
54 | ||
55 | front = g_malloc0(sizeof(*front)); | |
56 | front->name = g_strdup("Front"); | |
57 | front->channels = g_slist_append(front->channels, channel); | |
58 | ||
59 | sdi->channel_groups = g_slist_append(sdi->channel_groups, front); | |
60 | ||
61 | return chan_idx; | |
62 | } | |
63 | ||
64 | static int create_rear_channels(struct sr_dev_inst *sdi, int chan_idx, | |
65 | const struct rear_card_info *card) | |
66 | { | |
67 | unsigned int i; | |
68 | struct sr_channel *channel; | |
69 | struct sr_channel_group *group; | |
70 | struct channel_context *chanc; | |
71 | char name[16]; | |
72 | ||
73 | /* When card is NULL, we couldn't identify the type of card. */ | |
74 | if (!card) | |
75 | return chan_idx; | |
76 | ||
77 | group = g_malloc0(sizeof(*group)); | |
78 | group->priv = NULL; | |
79 | group->name = g_strdup(card->cg_name); | |
80 | sdi->channel_groups = g_slist_append(sdi->channel_groups, group); | |
81 | ||
82 | for (i = 0; i < card->num_channels; i++) { | |
83 | ||
84 | chanc = g_malloc(sizeof(*chanc)); | |
85 | chanc->location = CONN_REAR; | |
86 | ||
87 | if (card->type == REAR_TERMINALS) { | |
88 | chanc->index = -1; | |
89 | g_snprintf(name, sizeof(name), "%s", card->cg_name); | |
90 | } else { | |
91 | chanc->index = i; | |
92 | g_snprintf(name, sizeof(name), "%s%u", card->cg_name, i); | |
93 | } | |
94 | ||
95 | channel = sr_channel_new(sdi, chan_idx++, SR_CHANNEL_ANALOG, | |
96 | FALSE, name); | |
97 | channel->priv = chanc; | |
98 | group->channels = g_slist_append(group->channels, channel); | |
99 | } | |
100 | ||
101 | return chan_idx; | |
102 | } | |
103 | ||
104 | static gchar *get_revision(struct sr_scpi_dev_inst *scpi) | |
105 | { | |
106 | int ret, major, minor; | |
107 | GArray *rev_numbers; | |
108 | ||
109 | /* Report a version of '0.0' if we can't parse the response. */ | |
110 | major = minor = 0; | |
111 | ||
112 | ret = sr_scpi_get_floatv(scpi, "REV?", &rev_numbers); | |
113 | if ((ret == SR_OK) && (rev_numbers->len >= 2)) { | |
114 | major = (int)g_array_index(rev_numbers, float, 0); | |
115 | minor = (int)g_array_index(rev_numbers, float, 1); | |
116 | } | |
117 | ||
118 | g_array_free(rev_numbers, TRUE); | |
119 | ||
120 | return g_strdup_printf("%d.%d", major, minor); | |
121 | } | |
122 | ||
123 | static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi) | |
124 | { | |
125 | int ret, idx; | |
126 | char *response; | |
127 | struct sr_dev_inst *sdi; | |
128 | struct dev_context *devc; | |
129 | ||
130 | /* | |
131 | * This command ensures we receive an EOI after every response, so that | |
132 | * we don't wait the entire timeout after the response is received. | |
133 | */ | |
134 | if (sr_scpi_send(scpi, "END ALWAYS") != SR_OK) | |
135 | return NULL; | |
136 | ||
137 | ret = sr_scpi_get_string(scpi, "ID?", &response); | |
138 | if ((ret != SR_OK) || !response) | |
139 | return NULL; | |
140 | ||
141 | if (strcmp(response, "HP3457A")) | |
142 | return NULL; | |
143 | ||
144 | g_free(response); | |
145 | ||
146 | devc = g_malloc0(sizeof(struct dev_context)); | |
147 | sdi = g_malloc0(sizeof(struct sr_dev_inst)); | |
148 | sdi->vendor = g_strdup("Hewlett-Packard"); | |
149 | sdi->model = g_strdup("3457A"); | |
150 | sdi->version = get_revision(scpi); | |
151 | sdi->conn = scpi; | |
152 | sdi->driver = &hp_3457a_driver_info; | |
153 | sdi->inst_type = SR_INST_SCPI; | |
154 | sdi->priv = devc; | |
155 | ||
156 | /* There is no way to probe the measurement mode. It must be set. */ | |
157 | devc->measurement_mq = 0; | |
158 | devc->measurement_unit = 0; | |
159 | ||
160 | /* Probe rear card option and create channels accordingly (TODO). */ | |
161 | devc->rear_card = hp_3457a_probe_rear_card(scpi); | |
162 | idx = 0; | |
163 | idx = create_front_channel(sdi, idx); | |
164 | create_rear_channels(sdi, idx, devc->rear_card); | |
165 | ||
166 | return sdi; | |
167 | } | |
168 | ||
169 | static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx) | |
170 | { | |
171 | return std_init(sr_ctx, di, LOG_PREFIX); | |
172 | } | |
173 | ||
174 | static GSList *scan(struct sr_dev_driver *di, GSList *options) | |
175 | { | |
176 | return sr_scpi_scan(di->context, options, probe_device); | |
177 | } | |
178 | ||
179 | static GSList *dev_list(const struct sr_dev_driver *di) | |
180 | { | |
181 | return ((struct drv_context *)(di->context))->instances; | |
182 | } | |
183 | ||
184 | static int dev_clear(const struct sr_dev_driver *di) | |
185 | { | |
186 | return std_dev_clear(di, NULL); | |
187 | } | |
188 | ||
189 | /* | |
190 | * We need to set the HP 3457A to a known state, and there are quite a number | |
191 | * of knobs to tweak. Here's a brief explanation of what's going on. For more | |
192 | * details, print out and consult the user manual. | |
193 | * PRESET | |
194 | * Set the instrument to a pre-determined state. This is easier and faster | |
195 | * than sending a few dozen commands. Some of the PRESET defaults include | |
196 | * ASCII output format, and synchronous triggering. See user manual for | |
197 | * more details. | |
198 | * | |
199 | * After the PRESET command, the instrument is in a known state, and only those | |
200 | * parameters for which the default is unsuitable are modified: | |
201 | * INBUF ON | |
202 | * Enable the HP-IB input buffer. This allows the instrument to release the | |
203 | * HP-IB bus before processing the command, and increases throughput on | |
204 | * GPIB buses with more than one device. | |
205 | * TRIG HOLD | |
206 | * Do not trigger new measurements until instructed to do so. | |
207 | */ | |
208 | static int dev_open(struct sr_dev_inst *sdi) | |
209 | { | |
210 | struct sr_scpi_dev_inst *scpi = sdi->conn; | |
211 | struct dev_context *devc; | |
212 | ||
213 | if (sr_scpi_open(scpi) != SR_OK) | |
214 | return SR_ERR; | |
215 | ||
216 | devc=sdi->priv; | |
217 | ||
218 | sr_scpi_send(scpi, "PRESET"); | |
219 | sr_scpi_send(scpi, "INBUF ON"); | |
220 | sr_scpi_send(scpi, "TRIG HOLD"); | |
221 | sr_scpi_get_float(scpi, "NPLC?", &devc->nplc); | |
222 | ||
223 | sdi->status = SR_ST_ACTIVE; | |
224 | ||
225 | return SR_OK; | |
226 | } | |
227 | ||
228 | static int dev_close(struct sr_dev_inst *sdi) | |
229 | { | |
230 | struct sr_scpi_dev_inst *scpi = sdi->conn; | |
231 | ||
232 | if (sdi->status != SR_ST_ACTIVE) | |
233 | return SR_ERR_DEV_CLOSED; | |
234 | ||
235 | /* Disable scan-advance (preserve relay life). */ | |
236 | sr_scpi_send(scpi, "SADV HOLD"); | |
237 | /* Switch back to auto-triggering. */ | |
238 | sr_scpi_send(scpi, "TRIG AUTO"); | |
239 | ||
240 | sr_scpi_close(scpi); | |
241 | ||
242 | sdi->status = SR_ST_INACTIVE; | |
243 | ||
244 | return SR_OK; | |
245 | } | |
246 | ||
247 | static int cleanup(const struct sr_dev_driver *di) | |
248 | { | |
249 | return dev_clear(di); | |
250 | } | |
251 | ||
252 | static int config_get(uint32_t key, GVariant **data, | |
253 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
254 | { | |
255 | int ret; | |
256 | struct dev_context *devc; | |
257 | ||
258 | (void)cg; | |
259 | ||
260 | devc = sdi->priv; | |
261 | ||
262 | ret = SR_OK; | |
263 | switch (key) { | |
264 | case SR_CONF_ADC_POWERLINE_CYCLES: | |
265 | *data = g_variant_new_double(devc->nplc); | |
266 | break; | |
267 | default: | |
268 | return SR_ERR_NA; | |
269 | } | |
270 | ||
271 | return ret; | |
272 | } | |
273 | ||
274 | static int config_set(uint32_t key, GVariant *data, | |
275 | const struct sr_dev_inst *sdi, | |
276 | const struct sr_channel_group *cg) | |
277 | { | |
278 | int ret; | |
279 | enum sr_mq mq; | |
280 | enum sr_mqflag mq_flags; | |
281 | struct dev_context *devc; | |
282 | GVariant *tuple_child; | |
283 | ||
284 | (void)cg; | |
285 | ||
286 | if (sdi->status != SR_ST_ACTIVE) | |
287 | return SR_ERR_DEV_CLOSED; | |
288 | ||
289 | devc = sdi->priv; | |
290 | ||
291 | ret = SR_OK; | |
292 | switch (key) { | |
293 | case SR_CONF_LIMIT_SAMPLES: | |
294 | devc->limit_samples = g_variant_get_uint64(data); | |
295 | break; | |
296 | case SR_CONF_MEASURED_QUANTITY: | |
297 | tuple_child = g_variant_get_child_value(data, 0); | |
298 | mq = g_variant_get_uint32(tuple_child); | |
299 | tuple_child = g_variant_get_child_value(data, 1); | |
300 | mq_flags = g_variant_get_uint64(tuple_child); | |
301 | ret = hp_3457a_set_mq(sdi, mq, mq_flags); | |
302 | g_variant_unref(tuple_child); | |
303 | break; | |
304 | case SR_CONF_ADC_POWERLINE_CYCLES: | |
305 | ret = hp_3457a_set_nplc(sdi, g_variant_get_double(data)); | |
306 | break; | |
307 | default: | |
308 | ret = SR_ERR_NA; | |
309 | } | |
310 | ||
311 | return ret; | |
312 | } | |
313 | ||
314 | static int config_list(uint32_t key, GVariant **data, | |
315 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
316 | { | |
317 | int ret; | |
318 | ||
319 | if (key == SR_CONF_SCAN_OPTIONS) { | |
320 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
321 | scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t)); | |
322 | return SR_OK; | |
323 | } else if ((key == SR_CONF_DEVICE_OPTIONS) && !sdi) { | |
324 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
325 | drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t)); | |
326 | return SR_OK; | |
327 | } else if ((key == SR_CONF_DEVICE_OPTIONS) && !cg) { | |
328 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
329 | devopts, ARRAY_SIZE(devopts), sizeof(uint32_t)); | |
330 | return SR_OK; | |
331 | } | |
332 | ||
333 | /* From here on, we're only concerned with channel group config. */ | |
334 | if (!cg) | |
335 | return SR_ERR_NA; | |
336 | ||
337 | /* | |
338 | * TODO: Implement channel group configuration when adding support for | |
339 | * plug-in cards. | |
340 | */ | |
341 | ||
342 | ret = SR_OK; | |
343 | switch (key) { | |
344 | default: | |
345 | ret = SR_ERR_NA; | |
346 | } | |
347 | ||
348 | return ret; | |
349 | } | |
350 | ||
351 | static void create_channel_index_list(GSList *channels, GArray **arr) | |
352 | { | |
353 | struct sr_channel *channel; | |
354 | struct channel_context *chanc; | |
355 | GSList *list_elem; | |
356 | ||
357 | *arr = g_array_new(FALSE, FALSE, sizeof(unsigned int)); | |
358 | ||
359 | for (list_elem = channels; list_elem; list_elem = list_elem->next) { | |
360 | channel = list_elem->data; | |
361 | chanc = channel->priv; | |
362 | g_array_append_val(*arr, chanc->index); | |
363 | } | |
364 | } | |
365 | ||
366 | /* | |
367 | * TRIG SGL | |
368 | * Trigger the first measurement, then hold. We can't let the instrument | |
369 | * auto-trigger because we read several registers to make a complete | |
370 | * reading. If the instrument were auto-triggering, we could get the | |
371 | * reading for sample N, but a new measurement is made and when we read the | |
372 | * HIRES register, it contains data for sample N+1. This would produce | |
373 | * wrong readings. | |
374 | * SADV AUTO | |
375 | * Activate the scan-advance feature. This automatically connects the next | |
376 | * channel in the scan list to the A/D converter. This way, we do not need to | |
377 | * occupy the HP-IB bus to send channel select commands. | |
378 | */ | |
379 | static int dev_acquisition_start(const struct sr_dev_inst *sdi) | |
380 | { | |
381 | int ret; | |
382 | gboolean front_selected, rear_selected; | |
383 | struct sr_scpi_dev_inst *scpi; | |
384 | struct sr_channel *channel; | |
385 | struct dev_context *devc; | |
386 | struct channel_context *chanc; | |
387 | GArray *ch_list; | |
388 | GSList *channels; | |
389 | ||
390 | if (sdi->status != SR_ST_ACTIVE) | |
391 | return SR_ERR_DEV_CLOSED; | |
392 | ||
393 | scpi = sdi->conn; | |
394 | devc = sdi->priv; | |
395 | ||
396 | ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 100, | |
397 | hp_3457a_receive_data, (void *)sdi); | |
398 | if (ret != SR_OK) | |
399 | return ret; | |
400 | ||
401 | std_session_send_df_header(sdi, LOG_PREFIX); | |
402 | ||
403 | front_selected = rear_selected = FALSE; | |
404 | devc->active_channels = NULL; | |
405 | ||
406 | for (channels = sdi->channels; channels; channels = channels->next) { | |
407 | channel = channels->data; | |
408 | ||
409 | if (!channel->enabled) | |
410 | continue; | |
411 | ||
412 | chanc = channel->priv; | |
413 | ||
414 | if (chanc->location == CONN_FRONT) | |
415 | front_selected = TRUE; | |
416 | if (chanc->location == CONN_REAR) | |
417 | rear_selected = TRUE; | |
418 | ||
419 | devc->active_channels = g_slist_append(devc->active_channels, channel); | |
420 | } | |
421 | ||
422 | if (front_selected && rear_selected) { | |
423 | sr_err("Can not use front and rear channels at the same time!"); | |
424 | g_slist_free(devc->active_channels); | |
425 | return SR_ERR_ARG; | |
426 | } | |
427 | ||
428 | devc->current_channel = devc->active_channels->data; | |
429 | devc->num_active_channels = g_slist_length(devc->active_channels); | |
430 | ||
431 | hp_3457a_select_input(sdi, front_selected ? CONN_FRONT : CONN_REAR); | |
432 | ||
433 | /* For plug-in cards, use the scan-advance features to scan channels. */ | |
434 | if (rear_selected && (devc->rear_card->card_id != REAR_TERMINALS)) { | |
435 | create_channel_index_list(devc->active_channels, &ch_list); | |
436 | hp_3457a_send_scan_list(sdi, (void *)ch_list->data, ch_list->len); | |
437 | sr_scpi_send(scpi, "SADV AUTO"); | |
438 | g_array_free(ch_list, TRUE); | |
439 | } | |
440 | ||
441 | /* Start first measurement. */ | |
442 | sr_scpi_send(scpi, "TRIG SGL"); | |
443 | devc->acq_state = ACQ_TRIGGERED_MEASUREMENT; | |
444 | devc->num_samples = 0; | |
445 | ||
446 | return SR_OK; | |
447 | } | |
448 | ||
449 | static int dev_acquisition_stop(struct sr_dev_inst *sdi) | |
450 | { | |
451 | struct dev_context *devc; | |
452 | ||
453 | devc = sdi->priv; | |
454 | ||
455 | g_slist_free(devc->active_channels); | |
456 | ||
457 | return SR_OK; | |
458 | } | |
459 | ||
460 | SR_PRIV struct sr_dev_driver hp_3457a_driver_info = { | |
461 | .name = "hp-3457a", | |
462 | .longname = "HP 3457A", | |
463 | .api_version = 1, | |
464 | .init = init, | |
465 | .cleanup = cleanup, | |
466 | .scan = scan, | |
467 | .dev_list = dev_list, | |
468 | .dev_clear = dev_clear, | |
469 | .config_get = config_get, | |
470 | .config_set = config_set, | |
471 | .config_list = config_list, | |
472 | .dev_open = dev_open, | |
473 | .dev_close = dev_close, | |
474 | .dev_acquisition_start = dev_acquisition_start, | |
475 | .dev_acquisition_stop = dev_acquisition_stop, | |
476 | .context = NULL, | |
477 | }; |