]> sigrok.org Git - libsigrok.git/blame - src/hardware/hp-3457a/api.c
std_gvar_tuple_array(): Change to allow for more ARRAY_AND_SIZE usage.
[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 207
00b2a092
AG
208 return SR_OK;
209}
210
211static 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
225static 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
245static int config_set(uint32_t key, GVariant *data,
db23af7f
AG
246 const struct sr_dev_inst *sdi,
247 const struct sr_channel_group *cg)
00b2a092
AG
248{
249 int ret;
db23af7f 250 enum sr_mq mq;
2c04f943 251 enum sr_mqflag mq_flags;
db23af7f
AG
252 struct dev_context *devc;
253 GVariant *tuple_child;
00b2a092 254
00b2a092
AG
255 (void)cg;
256
db23af7f
AG
257 devc = sdi->priv;
258
00b2a092
AG
259 ret = SR_OK;
260 switch (key) {
db23af7f
AG
261 case SR_CONF_LIMIT_SAMPLES:
262 devc->limit_samples = g_variant_get_uint64(data);
263 break;
264 case SR_CONF_MEASURED_QUANTITY:
265 tuple_child = g_variant_get_child_value(data, 0);
266 mq = g_variant_get_uint32(tuple_child);
2c04f943
AG
267 tuple_child = g_variant_get_child_value(data, 1);
268 mq_flags = g_variant_get_uint64(tuple_child);
269 ret = hp_3457a_set_mq(sdi, mq, mq_flags);
db23af7f
AG
270 g_variant_unref(tuple_child);
271 break;
272 case SR_CONF_ADC_POWERLINE_CYCLES:
273 ret = hp_3457a_set_nplc(sdi, g_variant_get_double(data));
274 break;
00b2a092
AG
275 default:
276 ret = SR_ERR_NA;
277 }
278
279 return ret;
280}
281
282static int config_list(uint32_t key, GVariant **data,
283 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
284{
db23af7f
AG
285 /*
286 * TODO: Implement channel group configuration when adding support for
287 * plug-in cards.
288 */
00b2a092 289
e66d1892 290 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
00b2a092
AG
291}
292
9a093be9
AG
293static void create_channel_index_list(GSList *channels, GArray **arr)
294{
295 struct sr_channel *channel;
296 struct channel_context *chanc;
297 GSList *list_elem;
298
299 *arr = g_array_new(FALSE, FALSE, sizeof(unsigned int));
300
301 for (list_elem = channels; list_elem; list_elem = list_elem->next) {
302 channel = list_elem->data;
303 chanc = channel->priv;
304 g_array_append_val(*arr, chanc->index);
305 }
306}
307
db23af7f
AG
308/*
309 * TRIG SGL
310 * Trigger the first measurement, then hold. We can't let the instrument
311 * auto-trigger because we read several registers to make a complete
312 * reading. If the instrument were auto-triggering, we could get the
313 * reading for sample N, but a new measurement is made and when we read the
314 * HIRES register, it contains data for sample N+1. This would produce
315 * wrong readings.
9a093be9
AG
316 * SADV AUTO
317 * Activate the scan-advance feature. This automatically connects the next
318 * channel in the scan list to the A/D converter. This way, we do not need to
319 * occupy the HP-IB bus to send channel select commands.
db23af7f 320 */
695dc859 321static int dev_acquisition_start(const struct sr_dev_inst *sdi)
00b2a092 322{
db23af7f 323 int ret;
9a093be9 324 gboolean front_selected, rear_selected;
db23af7f 325 struct sr_scpi_dev_inst *scpi;
9a093be9 326 struct sr_channel *channel;
db23af7f 327 struct dev_context *devc;
9a093be9
AG
328 struct channel_context *chanc;
329 GArray *ch_list;
330 GSList *channels;
db23af7f 331
db23af7f
AG
332 scpi = sdi->conn;
333 devc = sdi->priv;
334
335 ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 100,
336 hp_3457a_receive_data, (void *)sdi);
337 if (ret != SR_OK)
338 return ret;
339
bee2b016 340 std_session_send_df_header(sdi);
db23af7f 341
9a093be9
AG
342 front_selected = rear_selected = FALSE;
343 devc->active_channels = NULL;
344
345 for (channels = sdi->channels; channels; channels = channels->next) {
346 channel = channels->data;
347
348 if (!channel->enabled)
349 continue;
350
351 chanc = channel->priv;
352
353 if (chanc->location == CONN_FRONT)
354 front_selected = TRUE;
355 if (chanc->location == CONN_REAR)
356 rear_selected = TRUE;
357
358 devc->active_channels = g_slist_append(devc->active_channels, channel);
359 }
360
361 if (front_selected && rear_selected) {
362 sr_err("Can not use front and rear channels at the same time!");
363 g_slist_free(devc->active_channels);
364 return SR_ERR_ARG;
365 }
366
367 devc->current_channel = devc->active_channels->data;
368 devc->num_active_channels = g_slist_length(devc->active_channels);
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 388static 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 399static 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 417SR_REGISTER_DEV_DRIVER(hp_3457a_driver_info);