]> sigrok.org Git - libsigrok.git/blame - src/hardware/scpi-pps/api.c
scpi-pps: Add configurable sr_mqflags.
[libsigrok.git] / src / hardware / scpi-pps / api.c
CommitLineData
ca1a7cb5
BV
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
7e66bf05 5 * Copyright (C) 2017,2019 Frank Stettner <frank-stettner@gmx.net>
ca1a7cb5
BV
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
6ec6c43b 21#include <config.h>
9e45cd41 22#include <string.h>
ba464a12 23#include <strings.h>
91ef511d 24#include "scpi.h"
ca1a7cb5
BV
25#include "protocol.h"
26
dd5c48a6 27static struct sr_dev_driver scpi_pps_driver_info;
c2af709b 28static struct sr_dev_driver hp_ib_pps_driver_info;
9e45cd41 29
584560f1 30static const uint32_t scanopts[] = {
9e45cd41
BV
31 SR_CONF_CONN,
32 SR_CONF_SERIALCOMM,
33};
ca1a7cb5 34
9d9cf1c4 35static const uint32_t drvopts[] = {
a258204e 36 SR_CONF_POWER_SUPPLY,
a258204e
BV
37};
38
329733d9 39static const struct pps_channel_instance pci[] = {
01b0257a
BV
40 { SR_MQ_VOLTAGE, SCPI_CMD_GET_MEAS_VOLTAGE, "V" },
41 { SR_MQ_CURRENT, SCPI_CMD_GET_MEAS_CURRENT, "I" },
42 { SR_MQ_POWER, SCPI_CMD_GET_MEAS_POWER, "P" },
4264f1c0 43 { SR_MQ_FREQUENCY, SCPI_CMD_GET_MEAS_FREQUENCY, "F" },
01b0257a
BV
44};
45
c2af709b 46static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi,
d9251a2c
UH
47 int (*get_hw_id)(struct sr_scpi_dev_inst *scpi,
48 struct sr_scpi_hw_info **scpi_response))
ca1a7cb5 49{
9e45cd41
BV
50 struct dev_context *devc;
51 struct sr_dev_inst *sdi;
52 struct sr_scpi_hw_info *hw_info;
53 struct sr_channel_group *cg;
54 struct sr_channel *ch;
55 const struct scpi_pps *device;
01b0257a 56 struct pps_channel *pch;
4a471029
BV
57 struct channel_spec *channels;
58 struct channel_group_spec *channel_groups, *cgs;
9e45cd41 59 struct pps_channel_group *pcg;
58b77c41
BV
60 GRegex *model_re;
61 GMatchInfo *model_mi;
01b0257a 62 GSList *l;
9e45cd41 63 uint64_t mask;
4a471029
BV
64 unsigned int num_channels, num_channel_groups, ch_num, ch_idx, i, j;
65 int ret;
22c18b03 66 const char *vendor;
01b0257a 67 char ch_name[16];
9e45cd41 68
c2af709b 69 if (get_hw_id(scpi, &hw_info) != SR_OK) {
9e45cd41
BV
70 sr_info("Couldn't get IDN response.");
71 return NULL;
72 }
73
74 device = NULL;
75 for (i = 0; i < num_pps_profiles; i++) {
91ef511d 76 vendor = sr_vendor_alias(hw_info->manufacturer);
34577da6 77 if (g_ascii_strcasecmp(vendor, pps_profiles[i].vendor))
22c18b03 78 continue;
58b77c41
BV
79 model_re = g_regex_new(pps_profiles[i].model, 0, 0, NULL);
80 if (g_regex_match(model_re, hw_info->model, 0, &model_mi))
9e45cd41 81 device = &pps_profiles[i];
58b77c41
BV
82 g_match_info_unref(model_mi);
83 g_regex_unref(model_re);
84 if (device)
9e45cd41 85 break;
9e45cd41
BV
86 }
87 if (!device) {
88 sr_scpi_hw_info_free(hw_info);
89 return NULL;
90 }
91
aac29cc1 92 sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be
UH
93 sdi->vendor = g_strdup(vendor);
94 sdi->model = g_strdup(hw_info->model);
95 sdi->version = g_strdup(hw_info->firmware_version);
9e45cd41 96 sdi->conn = scpi;
4f840ce9 97 sdi->driver = &scpi_pps_driver_info;
9e45cd41 98 sdi->inst_type = SR_INST_SCPI;
d08667c5
SA
99 sdi->serial_num = g_strdup(hw_info->serial_number);
100
9e45cd41
BV
101 devc = g_malloc0(sizeof(struct dev_context));
102 devc->device = device;
88e4daa9 103 sr_sw_limits_init(&devc->limits);
9e45cd41
BV
104 sdi->priv = devc;
105
4a471029
BV
106 if (device->num_channels) {
107 /* Static channels and groups. */
329733d9 108 channels = (struct channel_spec *)device->channels;
4a471029 109 num_channels = device->num_channels;
329733d9 110 channel_groups = (struct channel_group_spec *)device->channel_groups;
4a471029
BV
111 num_channel_groups = device->num_channel_groups;
112 } else {
113 /* Channels and groups need to be probed. */
114 ret = device->probe_channels(sdi, hw_info, &channels, &num_channels,
115 &channel_groups, &num_channel_groups);
116 if (ret != SR_OK) {
117 sr_err("Failed to probe for channels.");
118 return NULL;
119 }
120 /*
121 * Since these were dynamically allocated, we'll need to free them
122 * later.
123 */
124 devc->channels = channels;
125 devc->channel_groups = channel_groups;
126 }
127
01b0257a 128 ch_idx = 0;
4a471029 129 for (ch_num = 0; ch_num < num_channels; ch_num++) {
01b0257a 130 /* Create one channel per measurable output unit. */
01b0257a 131 for (i = 0; i < ARRAY_SIZE(pci); i++) {
fa2ce8c7 132 if (!sr_scpi_cmd_get(devc->device->commands, pci[i].command))
01b0257a
BV
133 continue;
134 g_snprintf(ch_name, 16, "%s%s", pci[i].prefix,
4a471029 135 channels[ch_num].name);
5e23fcab
ML
136 ch = sr_channel_new(sdi, ch_idx++, SR_CHANNEL_ANALOG, TRUE,
137 ch_name);
01b0257a
BV
138 pch = g_malloc0(sizeof(struct pps_channel));
139 pch->hw_output_idx = ch_num;
4a471029 140 pch->hwname = channels[ch_num].name;
01b0257a
BV
141 pch->mq = pci[i].mq;
142 ch->priv = pch;
01b0257a 143 }
9e45cd41 144 }
ca1a7cb5 145
4a471029
BV
146 for (i = 0; i < num_channel_groups; i++) {
147 cgs = &channel_groups[i];
9e45cd41
BV
148 cg = g_malloc0(sizeof(struct sr_channel_group));
149 cg->name = g_strdup(cgs->name);
150 for (j = 0, mask = 1; j < 64; j++, mask <<= 1) {
151 if (cgs->channel_index_mask & mask) {
01b0257a
BV
152 for (l = sdi->channels; l; l = l->next) {
153 ch = l->data;
154 pch = ch->priv;
f2bbcc33
FS
155 /* Add mqflags from channel_group_spec only to voltage
156 * and current channels
157 */
158 if (pch->mq == SR_MQ_VOLTAGE || pch->mq == SR_MQ_CURRENT)
159 pch->mqflags = cgs->mqflags;
160 else
161 pch->mqflags = 0;
01b0257a
BV
162 if (pch->hw_output_idx == j)
163 cg->channels = g_slist_append(cg->channels, ch);
164 }
9e45cd41
BV
165 }
166 }
167 pcg = g_malloc0(sizeof(struct pps_channel_group));
168 pcg->features = cgs->features;
169 cg->priv = pcg;
170 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
171 }
ca1a7cb5 172
4a471029
BV
173 sr_scpi_hw_info_free(hw_info);
174 hw_info = NULL;
175
17a82e83 176 sr_scpi_cmd(sdi, devc->device->commands, 0, NULL, SCPI_CMD_LOCAL);
ca1a7cb5 177
9e45cd41
BV
178 return sdi;
179}
ca1a7cb5 180
c2af709b 181static gchar *hpib_get_revision(struct sr_scpi_dev_inst *scpi)
9e45cd41 182{
c2af709b
AG
183 int ret;
184 gboolean matches;
185 char *response;
186 GRegex *version_regex;
187
188 ret = sr_scpi_get_string(scpi, "ROM?", &response);
189 if (ret != SR_OK && !response)
190 return NULL;
191
192 /* Example version string: "B01 B01" */
193 version_regex = g_regex_new("[A-Z][0-9]{2} [A-Z][0-9]{2}", 0, 0, NULL);
194 matches = g_regex_match(version_regex, response, 0, NULL);
195 g_regex_unref(version_regex);
196
197 if (!matches) {
198 /* Not a valid version string. Ignore it. */
199 g_free(response);
200 response = NULL;
201 } else {
202 /* Replace space with dot. */
203 response[3] = '.';
204 }
205
206 return response;
207}
208
209/*
210 * This function assumes the response is in the form "HP<model_number>"
211 *
212 * HP made many GPIB (then called HP-IB) instruments before the SCPI command
213 * set was introduced into the standard. We haven't seen any non-HP instruments
214 * which respond to the "ID?" query, so assume all are HP for now.
215 */
216static int hpib_get_hw_id(struct sr_scpi_dev_inst *scpi,
217 struct sr_scpi_hw_info **scpi_response)
218{
219 int ret;
220 char *response;
221 struct sr_scpi_hw_info *hw_info;
222
223 ret = sr_scpi_get_string(scpi, "ID?", &response);
224 if ((ret != SR_OK) || !response)
225 return SR_ERR;
226
227 hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info));
228
229 *scpi_response = hw_info;
230 hw_info->model = response;
231 hw_info->firmware_version = hpib_get_revision(scpi);
232 hw_info->manufacturer = g_strdup("HP");
233
234 return SR_OK;
235}
236
237static struct sr_dev_inst *probe_scpi_pps_device(struct sr_scpi_dev_inst *scpi)
238{
239 return probe_device(scpi, sr_scpi_get_hw_id);
240}
241
242static struct sr_dev_inst *probe_hpib_pps_device(struct sr_scpi_dev_inst *scpi)
243{
244 return probe_device(scpi, hpib_get_hw_id);
245}
246
247static GSList *scan_scpi_pps(struct sr_dev_driver *di, GSList *options)
248{
249 return sr_scpi_scan(di->context, options, probe_scpi_pps_device);
250}
251
252static GSList *scan_hpib_pps(struct sr_dev_driver *di, GSList *options)
253{
254 return sr_scpi_scan(di->context, options, probe_hpib_pps_device);
ca1a7cb5
BV
255}
256
ca1a7cb5
BV
257static int dev_open(struct sr_dev_inst *sdi)
258{
ee2860ee 259 struct dev_context *devc;
9e45cd41 260 struct sr_scpi_dev_inst *scpi;
ee2860ee 261 GVariant *beeper;
9e45cd41 262
9e45cd41
BV
263 scpi = sdi->conn;
264 if (sr_scpi_open(scpi) < 0)
265 return SR_ERR;
ca1a7cb5 266
91ef511d 267 devc = sdi->priv;
17a82e83 268 sr_scpi_cmd(sdi, devc->device->commands, 0, NULL, SCPI_CMD_REMOTE);
ee2860ee 269 devc->beeper_was_set = FALSE;
17a82e83
FS
270 if (sr_scpi_cmd_resp(sdi, devc->device->commands, 0, NULL,
271 &beeper, G_VARIANT_TYPE_BOOLEAN, SCPI_CMD_BEEPER) == SR_OK) {
ee2860ee
BV
272 if (g_variant_get_boolean(beeper)) {
273 devc->beeper_was_set = TRUE;
17a82e83
FS
274 sr_scpi_cmd(sdi, devc->device->commands,
275 0, NULL, SCPI_CMD_BEEPER_DISABLE);
ee2860ee
BV
276 }
277 g_variant_unref(beeper);
278 }
60475cd7 279
ca1a7cb5
BV
280 return SR_OK;
281}
282
283static int dev_close(struct sr_dev_inst *sdi)
284{
9e45cd41 285 struct sr_scpi_dev_inst *scpi;
ee2860ee 286 struct dev_context *devc;
ca1a7cb5 287
ee2860ee 288 devc = sdi->priv;
9e45cd41 289 scpi = sdi->conn;
ca1a7cb5 290
f1ba6b4b
UH
291 if (!scpi)
292 return SR_ERR_BUG;
293
294 if (devc->beeper_was_set)
17a82e83
FS
295 sr_scpi_cmd(sdi, devc->device->commands,
296 0, NULL, SCPI_CMD_BEEPER_ENABLE);
297 sr_scpi_cmd(sdi, devc->device->commands, 0, NULL, SCPI_CMD_LOCAL);
f1ba6b4b
UH
298
299 return sr_scpi_close(scpi);
ca1a7cb5
BV
300}
301
3553451f 302static void clear_helper(struct dev_context *devc)
4a471029 303{
4a471029
BV
304 g_free(devc->channels);
305 g_free(devc->channel_groups);
4a471029
BV
306}
307
1e726f56 308static int dev_clear(const struct sr_dev_driver *di)
ca1a7cb5 309{
3553451f 310 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
ca1a7cb5
BV
311}
312
dd7a72ea
UH
313static int config_get(uint32_t key, GVariant **data,
314 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
ca1a7cb5 315{
9e45cd41 316 struct dev_context *devc;
478c8d92
BV
317 const GVariantType *gvtype;
318 unsigned int i;
17a82e83
FS
319 int channel_group_cmd;
320 char *channel_group_name;
478c8d92 321 int cmd, ret;
069d9f25 322 const char *s;
8b5eadf4 323 int reg;
ca1a7cb5 324
9e45cd41
BV
325 if (!sdi)
326 return SR_ERR_ARG;
327
328 devc = sdi->priv;
ca1a7cb5 329
478c8d92 330 if (cg) {
9e45cd41
BV
331 /*
332 * These options only apply to channel groups with a single
333 * channel -- they're per-channel settings for the device.
334 */
478c8d92
BV
335
336 /*
337 * Config keys are handled below depending on whether a channel
338 * group was provided by the frontend. However some of these
339 * take a CG on one PPS but not on others. Check the device's
340 * profile for that here, and NULL out the channel group as needed.
341 */
342 for (i = 0; i < devc->device->num_devopts; i++) {
343 if (devc->device->devopts[i] == key) {
344 cg = NULL;
345 break;
346 }
347 }
478c8d92 348 }
9e45cd41 349
478c8d92
BV
350 gvtype = NULL;
351 cmd = -1;
352 switch (key) {
7a0b98b5 353 case SR_CONF_ENABLED:
478c8d92
BV
354 gvtype = G_VARIANT_TYPE_BOOLEAN;
355 cmd = SCPI_CMD_GET_OUTPUT_ENABLED;
356 break;
7a0b98b5 357 case SR_CONF_VOLTAGE:
478c8d92
BV
358 gvtype = G_VARIANT_TYPE_DOUBLE;
359 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
360 break;
7a0b98b5 361 case SR_CONF_VOLTAGE_TARGET:
478c8d92 362 gvtype = G_VARIANT_TYPE_DOUBLE;
ca95e90f 363 cmd = SCPI_CMD_GET_VOLTAGE_TARGET;
478c8d92 364 break;
4264f1c0
AG
365 case SR_CONF_OUTPUT_FREQUENCY:
366 gvtype = G_VARIANT_TYPE_DOUBLE;
367 cmd = SCPI_CMD_GET_MEAS_FREQUENCY;
368 break;
369 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
370 gvtype = G_VARIANT_TYPE_DOUBLE;
371 cmd = SCPI_CMD_GET_FREQUENCY_TARGET;
372 break;
7a0b98b5 373 case SR_CONF_CURRENT:
478c8d92
BV
374 gvtype = G_VARIANT_TYPE_DOUBLE;
375 cmd = SCPI_CMD_GET_MEAS_CURRENT;
376 break;
7a0b98b5 377 case SR_CONF_CURRENT_LIMIT:
478c8d92 378 gvtype = G_VARIANT_TYPE_DOUBLE;
ca95e90f 379 cmd = SCPI_CMD_GET_CURRENT_LIMIT;
478c8d92
BV
380 break;
381 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
382 gvtype = G_VARIANT_TYPE_BOOLEAN;
383 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED;
384 break;
385 case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
8b5eadf4
FS
386 if (devc->device->dialect == SCPI_DIALECT_HP_66XXB)
387 gvtype = G_VARIANT_TYPE_STRING;
388 else
389 gvtype = G_VARIANT_TYPE_BOOLEAN;
478c8d92
BV
390 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE;
391 break;
392 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
393 gvtype = G_VARIANT_TYPE_DOUBLE;
394 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD;
395 break;
396 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
397 gvtype = G_VARIANT_TYPE_BOOLEAN;
398 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED;
399 break;
400 case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
8b5eadf4
FS
401 if (devc->device->dialect == SCPI_DIALECT_HP_66XXB)
402 gvtype = G_VARIANT_TYPE_STRING;
403 else
404 gvtype = G_VARIANT_TYPE_BOOLEAN;
478c8d92
BV
405 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE;
406 break;
407 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
408 gvtype = G_VARIANT_TYPE_DOUBLE;
409 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD;
410 break;
411 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
412 gvtype = G_VARIANT_TYPE_BOOLEAN;
413 cmd = SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION;
414 break;
8b5eadf4
FS
415 case SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE:
416 if (devc->device->dialect == SCPI_DIALECT_HP_66XXB)
417 gvtype = G_VARIANT_TYPE_STRING;
418 else
419 gvtype = G_VARIANT_TYPE_BOOLEAN;
420 cmd = SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION_ACTIVE;
421 break;
7a0b98b5 422 case SR_CONF_REGULATION:
60475cd7
BV
423 gvtype = G_VARIANT_TYPE_STRING;
424 cmd = SCPI_CMD_GET_OUTPUT_REGULATION;
755793e9 425 break;
88e4daa9
ML
426 default:
427 return sr_sw_limits_config_get(&devc->limits, key, data);
478c8d92 428 }
91ef511d
BV
429 if (!gvtype)
430 return SR_ERR_NA;
431
17a82e83
FS
432 channel_group_cmd = 0;
433 channel_group_name = NULL;
434 if (cg) {
435 channel_group_cmd = SCPI_CMD_SELECT_CHANNEL;
436 channel_group_name = g_strdup(cg->name);
437 }
438
439 ret = sr_scpi_cmd_resp(sdi, devc->device->commands,
440 channel_group_cmd, channel_group_name, data, gvtype, cmd);
441 g_free(channel_group_name);
91ef511d 442
43ff1110
FS
443 /*
444 * Handle special cases
445 */
446
91ef511d 447 if (cmd == SCPI_CMD_GET_OUTPUT_REGULATION) {
43ff1110
FS
448 if (devc->device->dialect == SCPI_DIALECT_PHILIPS) {
449 /*
450 * The Philips PM2800 series returns VOLT/CURR. We always return
451 * a GVariant string in the Rigol notation (CV/CC/UR).
452 */
453 s = g_variant_get_string(*data, NULL);
454 if (!g_strcmp0(s, "VOLT")) {
455 g_variant_unref(*data);
456 *data = g_variant_new_string("CV");
457 } else if (!g_strcmp0(s, "CURR")) {
458 g_variant_unref(*data);
459 *data = g_variant_new_string("CC");
460 }
461 }
462 if (devc->device->dialect == SCPI_DIALECT_HP_66XXB) {
463 /* Evaluate Operational Status Register from a HP 66xxB. */
464 s = g_variant_get_string(*data, NULL);
8b5eadf4 465 sr_atoi(s, &reg);
069d9f25 466 g_variant_unref(*data);
8b5eadf4 467 if (reg & (1 << 8))
43ff1110 468 *data = g_variant_new_string("CV");
8b5eadf4 469 else if (reg & (1 << 10))
43ff1110 470 *data = g_variant_new_string("CC");
8b5eadf4 471 else if (reg & (1 << 11))
43ff1110
FS
472 *data = g_variant_new_string("CC-");
473 else
474 *data = g_variant_new_string("UR");
069d9f25
AJ
475 }
476
477 s = g_variant_get_string(*data, NULL);
43ff1110
FS
478 if (g_strcmp0(s, "CV") && g_strcmp0(s, "CC") &&
479 g_strcmp0(s, "CC-") && g_strcmp0(s, "UR")) {
480
481 sr_err("Unknown response to SCPI_CMD_GET_OUTPUT_REGULATION: %s", s);
91ef511d
BV
482 ret = SR_ERR_DATA;
483 }
91ef511d 484 }
ca1a7cb5 485
8b5eadf4
FS
486 if (cmd == SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE) {
487 if (devc->device->dialect == SCPI_DIALECT_HP_66XXB) {
488 /* Evaluate Questionable Status Register bit 0 from a HP 66xxB. */
489 s = g_variant_get_string(*data, NULL);
490 sr_atoi(s, &reg);
491 g_variant_unref(*data);
492 *data = g_variant_new_boolean(reg & (1 << 0));
493 }
494 }
495
496 if (cmd == SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE) {
497 if (devc->device->dialect == SCPI_DIALECT_HP_66XXB) {
498 /* Evaluate Questionable Status Register bit 1 from a HP 66xxB. */
499 s = g_variant_get_string(*data, NULL);
500 sr_atoi(s, &reg);
501 g_variant_unref(*data);
502 *data = g_variant_new_boolean(reg & (1 << 1));
503 }
504 }
505
506 if (cmd == SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION_ACTIVE) {
507 if (devc->device->dialect == SCPI_DIALECT_HP_66XXB) {
508 /* Evaluate Questionable Status Register bit 4 from a HP 66xxB. */
509 s = g_variant_get_string(*data, NULL);
510 sr_atoi(s, &reg);
511 g_variant_unref(*data);
512 *data = g_variant_new_boolean(reg & (1 << 4));
513 }
514 }
515
ca1a7cb5
BV
516 return ret;
517}
518
dd7a72ea
UH
519static int config_set(uint32_t key, GVariant *data,
520 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
ca1a7cb5 521{
91ef511d 522 struct dev_context *devc;
9e45cd41 523 double d;
17a82e83
FS
524 int channel_group_cmd;
525 char *channel_group_name;
526 int ret;
ca1a7cb5 527
fdedbfcd
BV
528 if (!sdi)
529 return SR_ERR_ARG;
530
17a82e83
FS
531 channel_group_cmd = 0;
532 channel_group_name = NULL;
533 if (cg) {
534 channel_group_cmd = SCPI_CMD_SELECT_CHANNEL;
535 channel_group_name = g_strdup(cg->name);
536 }
60475cd7 537
91ef511d 538 devc = sdi->priv;
e57057ae 539
60475cd7 540 switch (key) {
7a0b98b5 541 case SR_CONF_ENABLED:
60475cd7 542 if (g_variant_get_boolean(data))
17a82e83
FS
543 ret = sr_scpi_cmd(sdi, devc->device->commands,
544 channel_group_cmd, channel_group_name,
91ef511d 545 SCPI_CMD_SET_OUTPUT_ENABLE);
60475cd7 546 else
17a82e83
FS
547 ret = sr_scpi_cmd(sdi, devc->device->commands,
548 channel_group_cmd, channel_group_name,
91ef511d 549 SCPI_CMD_SET_OUTPUT_DISABLE);
60475cd7 550 break;
7a0b98b5 551 case SR_CONF_VOLTAGE_TARGET:
60475cd7 552 d = g_variant_get_double(data);
17a82e83
FS
553 ret = sr_scpi_cmd(sdi, devc->device->commands,
554 channel_group_cmd, channel_group_name,
91ef511d 555 SCPI_CMD_SET_VOLTAGE_TARGET, d);
60475cd7 556 break;
4264f1c0
AG
557 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
558 d = g_variant_get_double(data);
17a82e83
FS
559 ret = sr_scpi_cmd(sdi, devc->device->commands,
560 channel_group_cmd, channel_group_name,
91ef511d 561 SCPI_CMD_SET_FREQUENCY_TARGET, d);
4264f1c0 562 break;
7a0b98b5 563 case SR_CONF_CURRENT_LIMIT:
60475cd7 564 d = g_variant_get_double(data);
17a82e83
FS
565 ret = sr_scpi_cmd(sdi, devc->device->commands,
566 channel_group_cmd, channel_group_name,
91ef511d 567 SCPI_CMD_SET_CURRENT_LIMIT, d);
60475cd7
BV
568 break;
569 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
570 if (g_variant_get_boolean(data))
17a82e83
FS
571 ret = sr_scpi_cmd(sdi, devc->device->commands,
572 channel_group_cmd, channel_group_name,
91ef511d 573 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLE);
60475cd7 574 else
17a82e83
FS
575 ret = sr_scpi_cmd(sdi, devc->device->commands,
576 channel_group_cmd, channel_group_name,
91ef511d 577 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_DISABLE);
60475cd7
BV
578 break;
579 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
580 d = g_variant_get_double(data);
17a82e83
FS
581 ret = sr_scpi_cmd(sdi, devc->device->commands,
582 channel_group_cmd, channel_group_name,
91ef511d 583 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD, d);
60475cd7
BV
584 break;
585 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
586 if (g_variant_get_boolean(data))
17a82e83
FS
587 ret = sr_scpi_cmd(sdi, devc->device->commands,
588 channel_group_cmd, channel_group_name,
91ef511d 589 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLE);
60475cd7 590 else
17a82e83
FS
591 ret = sr_scpi_cmd(sdi, devc->device->commands,
592 channel_group_cmd, channel_group_name,
91ef511d 593 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_DISABLE);
60475cd7
BV
594 break;
595 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
596 d = g_variant_get_double(data);
17a82e83
FS
597 ret = sr_scpi_cmd(sdi, devc->device->commands,
598 channel_group_cmd, channel_group_name,
91ef511d 599 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD, d);
60475cd7
BV
600 break;
601 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
602 if (g_variant_get_boolean(data))
17a82e83
FS
603 ret = sr_scpi_cmd(sdi, devc->device->commands,
604 channel_group_cmd, channel_group_name,
91ef511d 605 SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_ENABLE);
60475cd7 606 else
17a82e83
FS
607 ret = sr_scpi_cmd(sdi, devc->device->commands,
608 channel_group_cmd, channel_group_name,
91ef511d 609 SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_DISABLE);
60475cd7
BV
610 break;
611 default:
88e4daa9 612 ret = sr_sw_limits_config_set(&devc->limits, key, data);
ca1a7cb5
BV
613 }
614
17a82e83
FS
615 g_free(channel_group_name);
616
617 return ret;
ca1a7cb5
BV
618}
619
dd7a72ea
UH
620static int config_list(uint32_t key, GVariant **data,
621 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
ca1a7cb5 622{
9e45cd41
BV
623 struct dev_context *devc;
624 struct sr_channel *ch;
329733d9 625 const struct channel_spec *ch_spec;
a9010323 626 int i;
9e45cd41
BV
627 const char *s[16];
628
e66d1892 629 devc = (sdi) ? sdi->priv : NULL;
ca1a7cb5 630
9e45cd41 631 if (!cg) {
9e45cd41 632 switch (key) {
e66d1892 633 case SR_CONF_SCAN_OPTIONS:
9e45cd41 634 case SR_CONF_DEVICE_OPTIONS:
e66d1892 635 return std_opts_config_list(key, data, sdi, cg,
53012da6
UH
636 ARRAY_AND_SIZE(scanopts),
637 ARRAY_AND_SIZE(drvopts),
08eba2d3
GS
638 (devc && devc->device) ? devc->device->devopts : NULL,
639 (devc && devc->device) ? devc->device->num_devopts : 0);
9e45cd41 640 break;
7a0b98b5 641 case SR_CONF_CHANNEL_CONFIG:
08eba2d3
GS
642 if (!devc || !devc->device)
643 return SR_ERR_ARG;
478c8d92 644 /* Not used. */
9e45cd41
BV
645 i = 0;
646 if (devc->device->features & PPS_INDEPENDENT)
647 s[i++] = "Independent";
648 if (devc->device->features & PPS_SERIES)
649 s[i++] = "Series";
650 if (devc->device->features & PPS_PARALLEL)
651 s[i++] = "Parallel";
652 if (i == 0) {
653 /*
654 * Shouldn't happen: independent-only devices
655 * shouldn't advertise this option at all.
656 */
657 return SR_ERR_NA;
658 }
659 *data = g_variant_new_strv(s, i);
660 break;
661 default:
662 return SR_ERR_NA;
663 }
664 } else {
9e45cd41
BV
665 /*
666 * Per-channel-group options depending on a channel are actually
667 * done with the first channel. Channel groups in PPS can have
668 * more than one channel, but they will typically be of equal
01b0257a 669 * specification for use in series or parallel mode.
9e45cd41 670 */
9e45cd41 671 ch = cg->channels->data;
08eba2d3
GS
672 if (!devc || !devc->device)
673 return SR_ERR_ARG;
54d471f4 674 ch_spec = &(devc->device->channels[ch->index]);
9e45cd41
BV
675
676 switch (key) {
677 case SR_CONF_DEVICE_OPTIONS:
105df674 678 *data = std_gvar_array_u32(devc->device->devopts_cg, devc->device->num_devopts_cg);
9e45cd41 679 break;
7a0b98b5 680 case SR_CONF_VOLTAGE_TARGET:
54d471f4 681 *data = std_gvar_min_max_step_array(ch_spec->voltage);
9e45cd41 682 break;
4264f1c0 683 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
54d471f4 684 *data = std_gvar_min_max_step_array(ch_spec->frequency);
4264f1c0 685 break;
7a0b98b5 686 case SR_CONF_CURRENT_LIMIT:
54d471f4 687 *data = std_gvar_min_max_step_array(ch_spec->current);
9e45cd41 688 break;
49a468ed
FS
689 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
690 *data = std_gvar_min_max_step_array(ch_spec->ovp);
691 break;
692 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
693 *data = std_gvar_min_max_step_array(ch_spec->ocp);
694 break;
9e45cd41
BV
695 default:
696 return SR_ERR_NA;
697 }
ca1a7cb5
BV
698 }
699
a9010323 700 return SR_OK;
ca1a7cb5
BV
701}
702
695dc859 703static int dev_acquisition_start(const struct sr_dev_inst *sdi)
ca1a7cb5 704{
9e45cd41
BV
705 struct dev_context *devc;
706 struct sr_scpi_dev_inst *scpi;
fa2ce8c7 707 int ret;
ca1a7cb5 708
9e45cd41
BV
709 devc = sdi->priv;
710 scpi = sdi->conn;
9e45cd41 711
17a82e83
FS
712 /* Prime the pipe with the first channel. */
713 devc->cur_acquisition_channel = sr_next_enabled_channel(sdi, NULL);
714
7e66bf05
FS
715 /* Device specific initialization before aquisition starts. */
716 if (devc->device->init_aquisition)
717 devc->device->init_aquisition(sdi);
718
01b0257a 719 if ((ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
9e45cd41
BV
720 scpi_pps_receive_data, (void *)sdi)) != SR_OK)
721 return ret;
bee2b016 722 std_session_send_df_header(sdi);
88e4daa9 723 sr_sw_limits_acquisition_start(&devc->limits);
9e45cd41 724
ca1a7cb5
BV
725 return SR_OK;
726}
727
695dc859 728static int dev_acquisition_stop(struct sr_dev_inst *sdi)
ca1a7cb5 729{
9e45cd41 730 struct sr_scpi_dev_inst *scpi;
9e45cd41 731
9e45cd41
BV
732 scpi = sdi->conn;
733
9e45cd41
BV
734 sr_scpi_source_remove(sdi->session, scpi);
735
bee2b016 736 std_session_send_df_end(sdi);
bf48cceb 737
ca1a7cb5
BV
738 return SR_OK;
739}
740
dd5c48a6 741static struct sr_dev_driver scpi_pps_driver_info = {
ca1a7cb5
BV
742 .name = "scpi-pps",
743 .longname = "SCPI PPS",
744 .api_version = 1,
c2fdcc25 745 .init = std_init,
700d6b64 746 .cleanup = std_cleanup,
c2af709b
AG
747 .scan = scan_scpi_pps,
748 .dev_list = std_dev_list,
749 .dev_clear = dev_clear,
750 .config_get = config_get,
751 .config_set = config_set,
752 .config_list = config_list,
753 .dev_open = dev_open,
754 .dev_close = dev_close,
755 .dev_acquisition_start = dev_acquisition_start,
756 .dev_acquisition_stop = dev_acquisition_stop,
757 .context = NULL,
758};
759
760static struct sr_dev_driver hp_ib_pps_driver_info = {
761 .name = "hpib-pps",
762 .longname = "HP-IB PPS",
763 .api_version = 1,
764 .init = std_init,
765 .cleanup = std_cleanup,
766 .scan = scan_hpib_pps,
c01bf34c 767 .dev_list = std_dev_list,
ca1a7cb5
BV
768 .dev_clear = dev_clear,
769 .config_get = config_get,
770 .config_set = config_set,
771 .config_list = config_list,
772 .dev_open = dev_open,
773 .dev_close = dev_close,
774 .dev_acquisition_start = dev_acquisition_start,
775 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 776 .context = NULL,
ca1a7cb5 777};
dd5c48a6 778SR_REGISTER_DEV_DRIVER(scpi_pps_driver_info);
c2af709b 779SR_REGISTER_DEV_DRIVER(hp_ib_pps_driver_info);