]> sigrok.org Git - libsigrok.git/blame - src/hardware/hp-3457a/api.c
sr_dev_close(): Factor out SR_ERR_DEV_CLOSED check.
[libsigrok.git] / src / hardware / hp-3457a / api.c
CommitLineData
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
25static const uint32_t scanopts[] = {
26 SR_CONF_CONN,
27};
28
29static const uint32_t drvopts[] = {
30 SR_CONF_MULTIMETER,
31};
32
33static 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 40static struct sr_dev_driver hp_3457a_driver_info;
00b2a092 41
db23af7f 42static 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
64static 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
104static 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
123static 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
169static 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
193static 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
AG
207
208 sdi->status = SR_ST_ACTIVE;
209
210 return SR_OK;
211}
212
213static int dev_close(struct sr_dev_inst *sdi)
214{
db23af7f
AG
215 struct sr_scpi_dev_inst *scpi = sdi->conn;
216
9a093be9
AG
217 /* Disable scan-advance (preserve relay life). */
218 sr_scpi_send(scpi, "SADV HOLD");
db23af7f
AG
219 /* Switch back to auto-triggering. */
220 sr_scpi_send(scpi, "TRIG AUTO");
221
222 sr_scpi_close(scpi);
00b2a092
AG
223
224 sdi->status = SR_ST_INACTIVE;
225
226 return SR_OK;
227}
228
00b2a092
AG
229static int config_get(uint32_t key, GVariant **data,
230 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
231{
232 int ret;
db23af7f 233 struct dev_context *devc;
00b2a092 234
00b2a092
AG
235 (void)cg;
236
db23af7f
AG
237 devc = sdi->priv;
238
00b2a092
AG
239 ret = SR_OK;
240 switch (key) {
db23af7f
AG
241 case SR_CONF_ADC_POWERLINE_CYCLES:
242 *data = g_variant_new_double(devc->nplc);
243 break;
00b2a092
AG
244 default:
245 return SR_ERR_NA;
246 }
247
248 return ret;
249}
250
251static int config_set(uint32_t key, GVariant *data,
db23af7f
AG
252 const struct sr_dev_inst *sdi,
253 const struct sr_channel_group *cg)
00b2a092
AG
254{
255 int ret;
db23af7f 256 enum sr_mq mq;
2c04f943 257 enum sr_mqflag mq_flags;
db23af7f
AG
258 struct dev_context *devc;
259 GVariant *tuple_child;
00b2a092 260
00b2a092
AG
261 (void)cg;
262
db23af7f
AG
263 devc = sdi->priv;
264
00b2a092
AG
265 ret = SR_OK;
266 switch (key) {
db23af7f
AG
267 case SR_CONF_LIMIT_SAMPLES:
268 devc->limit_samples = g_variant_get_uint64(data);
269 break;
270 case SR_CONF_MEASURED_QUANTITY:
271 tuple_child = g_variant_get_child_value(data, 0);
272 mq = g_variant_get_uint32(tuple_child);
2c04f943
AG
273 tuple_child = g_variant_get_child_value(data, 1);
274 mq_flags = g_variant_get_uint64(tuple_child);
275 ret = hp_3457a_set_mq(sdi, mq, mq_flags);
db23af7f
AG
276 g_variant_unref(tuple_child);
277 break;
278 case SR_CONF_ADC_POWERLINE_CYCLES:
279 ret = hp_3457a_set_nplc(sdi, g_variant_get_double(data));
280 break;
00b2a092
AG
281 default:
282 ret = SR_ERR_NA;
283 }
284
285 return ret;
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{
291 int ret;
292
db23af7f
AG
293 if (key == SR_CONF_SCAN_OPTIONS) {
294 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
295 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
296 return SR_OK;
297 } else if ((key == SR_CONF_DEVICE_OPTIONS) && !sdi) {
298 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
299 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
300 return SR_OK;
301 } else if ((key == SR_CONF_DEVICE_OPTIONS) && !cg) {
302 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
303 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
304 return SR_OK;
305 }
306
307 /* From here on, we're only concerned with channel group config. */
308 if (!cg)
309 return SR_ERR_NA;
310
311 /*
312 * TODO: Implement channel group configuration when adding support for
313 * plug-in cards.
314 */
00b2a092
AG
315
316 ret = SR_OK;
317 switch (key) {
00b2a092 318 default:
db23af7f 319 ret = SR_ERR_NA;
00b2a092
AG
320 }
321
322 return ret;
323}
324
9a093be9
AG
325static void create_channel_index_list(GSList *channels, GArray **arr)
326{
327 struct sr_channel *channel;
328 struct channel_context *chanc;
329 GSList *list_elem;
330
331 *arr = g_array_new(FALSE, FALSE, sizeof(unsigned int));
332
333 for (list_elem = channels; list_elem; list_elem = list_elem->next) {
334 channel = list_elem->data;
335 chanc = channel->priv;
336 g_array_append_val(*arr, chanc->index);
337 }
338}
339
db23af7f
AG
340/*
341 * TRIG SGL
342 * Trigger the first measurement, then hold. We can't let the instrument
343 * auto-trigger because we read several registers to make a complete
344 * reading. If the instrument were auto-triggering, we could get the
345 * reading for sample N, but a new measurement is made and when we read the
346 * HIRES register, it contains data for sample N+1. This would produce
347 * wrong readings.
9a093be9
AG
348 * SADV AUTO
349 * Activate the scan-advance feature. This automatically connects the next
350 * channel in the scan list to the A/D converter. This way, we do not need to
351 * occupy the HP-IB bus to send channel select commands.
db23af7f 352 */
695dc859 353static int dev_acquisition_start(const struct sr_dev_inst *sdi)
00b2a092 354{
db23af7f 355 int ret;
9a093be9 356 gboolean front_selected, rear_selected;
db23af7f 357 struct sr_scpi_dev_inst *scpi;
9a093be9 358 struct sr_channel *channel;
db23af7f 359 struct dev_context *devc;
9a093be9
AG
360 struct channel_context *chanc;
361 GArray *ch_list;
362 GSList *channels;
db23af7f 363
db23af7f
AG
364 scpi = sdi->conn;
365 devc = sdi->priv;
366
367 ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 100,
368 hp_3457a_receive_data, (void *)sdi);
369 if (ret != SR_OK)
370 return ret;
371
bee2b016 372 std_session_send_df_header(sdi);
db23af7f 373
9a093be9
AG
374 front_selected = rear_selected = FALSE;
375 devc->active_channels = NULL;
376
377 for (channels = sdi->channels; channels; channels = channels->next) {
378 channel = channels->data;
379
380 if (!channel->enabled)
381 continue;
382
383 chanc = channel->priv;
384
385 if (chanc->location == CONN_FRONT)
386 front_selected = TRUE;
387 if (chanc->location == CONN_REAR)
388 rear_selected = TRUE;
389
390 devc->active_channels = g_slist_append(devc->active_channels, channel);
391 }
392
393 if (front_selected && rear_selected) {
394 sr_err("Can not use front and rear channels at the same time!");
395 g_slist_free(devc->active_channels);
396 return SR_ERR_ARG;
397 }
398
399 devc->current_channel = devc->active_channels->data;
400 devc->num_active_channels = g_slist_length(devc->active_channels);
401
402 hp_3457a_select_input(sdi, front_selected ? CONN_FRONT : CONN_REAR);
403
404 /* For plug-in cards, use the scan-advance features to scan channels. */
405 if (rear_selected && (devc->rear_card->card_id != REAR_TERMINALS)) {
406 create_channel_index_list(devc->active_channels, &ch_list);
407 hp_3457a_send_scan_list(sdi, (void *)ch_list->data, ch_list->len);
408 sr_scpi_send(scpi, "SADV AUTO");
409 g_array_free(ch_list, TRUE);
410 }
411
db23af7f
AG
412 /* Start first measurement. */
413 sr_scpi_send(scpi, "TRIG SGL");
414 devc->acq_state = ACQ_TRIGGERED_MEASUREMENT;
415 devc->num_samples = 0;
00b2a092
AG
416
417 return SR_OK;
418}
419
695dc859 420static int dev_acquisition_stop(struct sr_dev_inst *sdi)
00b2a092 421{
9a093be9 422 struct dev_context *devc;
00b2a092 423
9a093be9
AG
424 devc = sdi->priv;
425
9a093be9
AG
426 g_slist_free(devc->active_channels);
427
00b2a092
AG
428 return SR_OK;
429}
430
dd5c48a6 431static struct sr_dev_driver hp_3457a_driver_info = {
00b2a092
AG
432 .name = "hp-3457a",
433 .longname = "HP 3457A",
434 .api_version = 1,
c2fdcc25 435 .init = std_init,
700d6b64 436 .cleanup = std_cleanup,
00b2a092 437 .scan = scan,
c01bf34c 438 .dev_list = std_dev_list,
00b2a092
AG
439 .config_get = config_get,
440 .config_set = config_set,
441 .config_list = config_list,
442 .dev_open = dev_open,
443 .dev_close = dev_close,
444 .dev_acquisition_start = dev_acquisition_start,
445 .dev_acquisition_stop = dev_acquisition_stop,
446 .context = NULL,
447};
dd5c48a6 448SR_REGISTER_DEV_DRIVER(hp_3457a_driver_info);