]>
Commit | Line | Data |
---|---|---|
00b2a092 AG |
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> | |
db23af7f AG |
21 | #include <scpi.h> |
22 | #include <string.h> | |
00b2a092 AG |
23 | #include "protocol.h" |
24 | ||
db23af7f AG |
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[] = { | |
e91bb0a6 | 34 | SR_CONF_CONTINUOUS, |
db23af7f AG |
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 | ||
dd5c48a6 | 40 | static struct sr_dev_driver hp_3457a_driver_info; |
00b2a092 | 41 | |
db23af7f | 42 | static int create_front_channel(struct sr_dev_inst *sdi, int chan_idx) |
00b2a092 | 43 | { |
db23af7f AG |
44 | struct sr_channel *channel; |
45 | struct sr_channel_group *front; | |
9a093be9 AG |
46 | struct channel_context *chanc; |
47 | ||
48 | chanc = g_malloc(sizeof(*chanc)); | |
49 | chanc->location = CONN_FRONT; | |
db23af7f AG |
50 | |
51 | channel = sr_channel_new(sdi, chan_idx++, SR_CHANNEL_ANALOG, | |
52 | TRUE, "Front"); | |
9a093be9 | 53 | channel->priv = chanc; |
db23af7f AG |
54 | |
55 | front = g_malloc0(sizeof(*front)); | |
56 | front->name = g_strdup("Front"); | |
57 | front->channels = g_slist_append(front->channels, channel); | |
9a093be9 | 58 | |
db23af7f AG |
59 | sdi->channel_groups = g_slist_append(sdi->channel_groups, front); |
60 | ||
61 | return chan_idx; | |
00b2a092 AG |
62 | } |
63 | ||
db23af7f AG |
64 | static int create_rear_channels(struct sr_dev_inst *sdi, int chan_idx, |
65 | const struct rear_card_info *card) | |
66 | { | |
9a093be9 AG |
67 | unsigned int i; |
68 | struct sr_channel *channel; | |
69 | struct sr_channel_group *group; | |
70 | struct channel_context *chanc; | |
71 | char name[16]; | |
db23af7f AG |
72 | |
73 | /* When card is NULL, we couldn't identify the type of card. */ | |
74 | if (!card) | |
75 | return chan_idx; | |
76 | ||
9a093be9 AG |
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 | ||
db23af7f AG |
101 | return chan_idx; |
102 | } | |
103 | ||
104 | static gchar *get_revision(struct sr_scpi_dev_inst *scpi) | |
00b2a092 | 105 | { |
db23af7f AG |
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 | } | |
00b2a092 | 117 | |
db23af7f | 118 | g_array_free(rev_numbers, TRUE); |
00b2a092 | 119 | |
db23af7f AG |
120 | return g_strdup_printf("%d.%d", major, minor); |
121 | } | |
00b2a092 | 122 | |
db23af7f AG |
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 | } | |
00b2a092 | 168 | |
db23af7f AG |
169 | static GSList *scan(struct sr_dev_driver *di, GSList *options) |
170 | { | |
171 | return sr_scpi_scan(di->context, options, probe_device); | |
00b2a092 AG |
172 | } |
173 | ||
db23af7f AG |
174 | /* |
175 | * We need to set the HP 3457A to a known state, and there are quite a number | |
176 | * of knobs to tweak. Here's a brief explanation of what's going on. For more | |
177 | * details, print out and consult the user manual. | |
178 | * PRESET | |
179 | * Set the instrument to a pre-determined state. This is easier and faster | |
180 | * than sending a few dozen commands. Some of the PRESET defaults include | |
181 | * ASCII output format, and synchronous triggering. See user manual for | |
182 | * more details. | |
183 | * | |
184 | * After the PRESET command, the instrument is in a known state, and only those | |
185 | * parameters for which the default is unsuitable are modified: | |
186 | * INBUF ON | |
187 | * Enable the HP-IB input buffer. This allows the instrument to release the | |
188 | * HP-IB bus before processing the command, and increases throughput on | |
189 | * GPIB buses with more than one device. | |
190 | * TRIG HOLD | |
191 | * Do not trigger new measurements until instructed to do so. | |
192 | */ | |
00b2a092 AG |
193 | static int dev_open(struct sr_dev_inst *sdi) |
194 | { | |
db23af7f AG |
195 | struct sr_scpi_dev_inst *scpi = sdi->conn; |
196 | struct dev_context *devc; | |
197 | ||
198 | if (sr_scpi_open(scpi) != SR_OK) | |
199 | return SR_ERR; | |
00b2a092 | 200 | |
61c90858 | 201 | devc = sdi->priv; |
db23af7f AG |
202 | |
203 | sr_scpi_send(scpi, "PRESET"); | |
204 | sr_scpi_send(scpi, "INBUF ON"); | |
205 | sr_scpi_send(scpi, "TRIG HOLD"); | |
206 | sr_scpi_get_float(scpi, "NPLC?", &devc->nplc); | |
00b2a092 | 207 | |
00b2a092 AG |
208 | return SR_OK; |
209 | } | |
210 | ||
211 | static int dev_close(struct sr_dev_inst *sdi) | |
212 | { | |
db23af7f AG |
213 | struct sr_scpi_dev_inst *scpi = sdi->conn; |
214 | ||
9a093be9 AG |
215 | /* Disable scan-advance (preserve relay life). */ |
216 | sr_scpi_send(scpi, "SADV HOLD"); | |
db23af7f AG |
217 | /* Switch back to auto-triggering. */ |
218 | sr_scpi_send(scpi, "TRIG AUTO"); | |
219 | ||
220 | sr_scpi_close(scpi); | |
00b2a092 | 221 | |
00b2a092 AG |
222 | return SR_OK; |
223 | } | |
224 | ||
00b2a092 AG |
225 | static int config_get(uint32_t key, GVariant **data, |
226 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
227 | { | |
db23af7f | 228 | struct dev_context *devc; |
00b2a092 | 229 | |
00b2a092 AG |
230 | (void)cg; |
231 | ||
db23af7f AG |
232 | devc = sdi->priv; |
233 | ||
00b2a092 | 234 | switch (key) { |
db23af7f AG |
235 | case SR_CONF_ADC_POWERLINE_CYCLES: |
236 | *data = g_variant_new_double(devc->nplc); | |
237 | break; | |
00b2a092 AG |
238 | default: |
239 | return SR_ERR_NA; | |
240 | } | |
241 | ||
a9010323 | 242 | return SR_OK; |
00b2a092 AG |
243 | } |
244 | ||
245 | static int config_set(uint32_t key, GVariant *data, | |
dd7a72ea | 246 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) |
00b2a092 | 247 | { |
db23af7f | 248 | enum sr_mq mq; |
2c04f943 | 249 | enum sr_mqflag mq_flags; |
db23af7f AG |
250 | struct dev_context *devc; |
251 | GVariant *tuple_child; | |
00b2a092 | 252 | |
00b2a092 AG |
253 | (void)cg; |
254 | ||
db23af7f AG |
255 | devc = sdi->priv; |
256 | ||
00b2a092 | 257 | switch (key) { |
db23af7f AG |
258 | case SR_CONF_LIMIT_SAMPLES: |
259 | devc->limit_samples = g_variant_get_uint64(data); | |
260 | break; | |
261 | case SR_CONF_MEASURED_QUANTITY: | |
262 | tuple_child = g_variant_get_child_value(data, 0); | |
263 | mq = g_variant_get_uint32(tuple_child); | |
2c04f943 AG |
264 | tuple_child = g_variant_get_child_value(data, 1); |
265 | mq_flags = g_variant_get_uint64(tuple_child); | |
db23af7f | 266 | g_variant_unref(tuple_child); |
758906aa | 267 | return hp_3457a_set_mq(sdi, mq, mq_flags); |
db23af7f | 268 | case SR_CONF_ADC_POWERLINE_CYCLES: |
758906aa | 269 | return hp_3457a_set_nplc(sdi, g_variant_get_double(data)); |
00b2a092 | 270 | default: |
758906aa | 271 | return SR_ERR_NA; |
00b2a092 AG |
272 | } |
273 | ||
758906aa | 274 | return SR_OK; |
00b2a092 AG |
275 | } |
276 | ||
277 | static int config_list(uint32_t key, GVariant **data, | |
278 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
279 | { | |
db23af7f AG |
280 | /* |
281 | * TODO: Implement channel group configuration when adding support for | |
282 | * plug-in cards. | |
283 | */ | |
00b2a092 | 284 | |
e66d1892 | 285 | return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts); |
00b2a092 AG |
286 | } |
287 | ||
9a093be9 AG |
288 | static void create_channel_index_list(GSList *channels, GArray **arr) |
289 | { | |
290 | struct sr_channel *channel; | |
291 | struct channel_context *chanc; | |
292 | GSList *list_elem; | |
293 | ||
294 | *arr = g_array_new(FALSE, FALSE, sizeof(unsigned int)); | |
295 | ||
296 | for (list_elem = channels; list_elem; list_elem = list_elem->next) { | |
297 | channel = list_elem->data; | |
298 | chanc = channel->priv; | |
299 | g_array_append_val(*arr, chanc->index); | |
300 | } | |
301 | } | |
302 | ||
db23af7f AG |
303 | /* |
304 | * TRIG SGL | |
305 | * Trigger the first measurement, then hold. We can't let the instrument | |
306 | * auto-trigger because we read several registers to make a complete | |
307 | * reading. If the instrument were auto-triggering, we could get the | |
308 | * reading for sample N, but a new measurement is made and when we read the | |
309 | * HIRES register, it contains data for sample N+1. This would produce | |
310 | * wrong readings. | |
9a093be9 AG |
311 | * SADV AUTO |
312 | * Activate the scan-advance feature. This automatically connects the next | |
313 | * channel in the scan list to the A/D converter. This way, we do not need to | |
314 | * occupy the HP-IB bus to send channel select commands. | |
db23af7f | 315 | */ |
695dc859 | 316 | static int dev_acquisition_start(const struct sr_dev_inst *sdi) |
00b2a092 | 317 | { |
db23af7f | 318 | int ret; |
9a093be9 | 319 | gboolean front_selected, rear_selected; |
db23af7f | 320 | struct sr_scpi_dev_inst *scpi; |
9a093be9 | 321 | struct sr_channel *channel; |
db23af7f | 322 | struct dev_context *devc; |
9a093be9 AG |
323 | struct channel_context *chanc; |
324 | GArray *ch_list; | |
325 | GSList *channels; | |
db23af7f | 326 | |
db23af7f AG |
327 | scpi = sdi->conn; |
328 | devc = sdi->priv; | |
329 | ||
330 | ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 100, | |
331 | hp_3457a_receive_data, (void *)sdi); | |
332 | if (ret != SR_OK) | |
333 | return ret; | |
334 | ||
bee2b016 | 335 | std_session_send_df_header(sdi); |
db23af7f | 336 | |
9a093be9 AG |
337 | front_selected = rear_selected = FALSE; |
338 | devc->active_channels = NULL; | |
339 | ||
340 | for (channels = sdi->channels; channels; channels = channels->next) { | |
341 | channel = channels->data; | |
342 | ||
343 | if (!channel->enabled) | |
344 | continue; | |
345 | ||
346 | chanc = channel->priv; | |
347 | ||
348 | if (chanc->location == CONN_FRONT) | |
349 | front_selected = TRUE; | |
350 | if (chanc->location == CONN_REAR) | |
351 | rear_selected = TRUE; | |
352 | ||
353 | devc->active_channels = g_slist_append(devc->active_channels, channel); | |
354 | } | |
355 | ||
356 | if (front_selected && rear_selected) { | |
357 | sr_err("Can not use front and rear channels at the same time!"); | |
358 | g_slist_free(devc->active_channels); | |
359 | return SR_ERR_ARG; | |
360 | } | |
361 | ||
9a093be9 | 362 | devc->num_active_channels = g_slist_length(devc->active_channels); |
1674225a GS |
363 | if (!devc->num_active_channels) { |
364 | sr_err("Need at least one active channel!"); | |
365 | g_slist_free(devc->active_channels); | |
366 | return SR_ERR_ARG; | |
367 | } | |
368 | devc->current_channel = devc->active_channels->data; | |
9a093be9 AG |
369 | |
370 | hp_3457a_select_input(sdi, front_selected ? CONN_FRONT : CONN_REAR); | |
371 | ||
372 | /* For plug-in cards, use the scan-advance features to scan channels. */ | |
373 | if (rear_selected && (devc->rear_card->card_id != REAR_TERMINALS)) { | |
374 | create_channel_index_list(devc->active_channels, &ch_list); | |
375 | hp_3457a_send_scan_list(sdi, (void *)ch_list->data, ch_list->len); | |
376 | sr_scpi_send(scpi, "SADV AUTO"); | |
377 | g_array_free(ch_list, TRUE); | |
378 | } | |
379 | ||
db23af7f AG |
380 | /* Start first measurement. */ |
381 | sr_scpi_send(scpi, "TRIG SGL"); | |
382 | devc->acq_state = ACQ_TRIGGERED_MEASUREMENT; | |
383 | devc->num_samples = 0; | |
00b2a092 AG |
384 | |
385 | return SR_OK; | |
386 | } | |
387 | ||
695dc859 | 388 | static int dev_acquisition_stop(struct sr_dev_inst *sdi) |
00b2a092 | 389 | { |
9a093be9 | 390 | struct dev_context *devc; |
00b2a092 | 391 | |
9a093be9 AG |
392 | devc = sdi->priv; |
393 | ||
9a093be9 AG |
394 | g_slist_free(devc->active_channels); |
395 | ||
00b2a092 AG |
396 | return SR_OK; |
397 | } | |
398 | ||
dd5c48a6 | 399 | static struct sr_dev_driver hp_3457a_driver_info = { |
00b2a092 AG |
400 | .name = "hp-3457a", |
401 | .longname = "HP 3457A", | |
402 | .api_version = 1, | |
c2fdcc25 | 403 | .init = std_init, |
700d6b64 | 404 | .cleanup = std_cleanup, |
00b2a092 | 405 | .scan = scan, |
c01bf34c | 406 | .dev_list = std_dev_list, |
f778bf02 | 407 | .dev_clear = std_dev_clear, |
00b2a092 AG |
408 | .config_get = config_get, |
409 | .config_set = config_set, | |
410 | .config_list = config_list, | |
411 | .dev_open = dev_open, | |
412 | .dev_close = dev_close, | |
413 | .dev_acquisition_start = dev_acquisition_start, | |
414 | .dev_acquisition_stop = dev_acquisition_stop, | |
415 | .context = NULL, | |
416 | }; | |
dd5c48a6 | 417 | SR_REGISTER_DEV_DRIVER(hp_3457a_driver_info); |