2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
23 SR_PRIV struct sr_dev_driver scpi_pps_driver_info;
24 static struct sr_dev_driver *di = &scpi_pps_driver_info;
25 extern unsigned int num_pps_profiles;
26 extern const struct scpi_pps pps_profiles[];
28 static const int32_t scanopts[] = {
33 static struct pps_channel_instance pci[] = {
34 { SR_MQ_VOLTAGE, SCPI_CMD_GET_MEAS_VOLTAGE, "V" },
35 { SR_MQ_CURRENT, SCPI_CMD_GET_MEAS_CURRENT, "I" },
36 { SR_MQ_POWER, SCPI_CMD_GET_MEAS_POWER, "P" },
39 static int init(struct sr_context *sr_ctx)
41 return std_init(sr_ctx, di, LOG_PREFIX);
44 static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
46 struct dev_context *devc;
47 struct sr_dev_inst *sdi;
48 struct sr_scpi_hw_info *hw_info;
49 struct sr_channel_group *cg;
50 struct sr_channel *ch;
51 const struct scpi_pps *device;
52 struct pps_channel *pch;
53 const struct channel_group_spec *cgs;
54 struct pps_channel_group *pcg;
59 unsigned int ch_num, ch_idx, old_idx, i, j;
63 if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
64 sr_info("Couldn't get IDN response.");
69 for (i = 0; i < num_pps_profiles; i++) {
70 vendor = get_vendor(hw_info->manufacturer);
71 if (strcasecmp(vendor, pps_profiles[i].vendor))
73 model_re = g_regex_new(pps_profiles[i].model, 0, 0, NULL);
74 if (g_regex_match(model_re, hw_info->model, 0, &model_mi))
75 device = &pps_profiles[i];
76 g_match_info_unref(model_mi);
77 g_regex_unref(model_re);
82 sr_scpi_hw_info_free(hw_info);
86 sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, vendor, hw_info->model,
87 hw_info->firmware_version);
90 sdi->inst_type = SR_INST_SCPI;
91 devc = g_malloc0(sizeof(struct dev_context));
92 devc->device = device;
96 for (ch_num = 0; ch_num < device->num_channels; ch_num++) {
97 /* Create one channel per measurable output unit. */
99 for (i = 0; i < ARRAY_SIZE(pci); i++) {
100 if (!scpi_cmd_get(sdi, pci[i].command))
102 g_snprintf(ch_name, 16, "%s%s", pci[i].prefix,
103 device->channels[ch_num].name);
104 ch = sr_channel_new(ch_idx++, SR_CHANNEL_ANALOG, TRUE, ch_name);
105 pch = g_malloc0(sizeof(struct pps_channel));
106 pch->hw_output_idx = ch_num;
107 pch->hwname = device->channels[ch_num].name;
110 sdi->channels = g_slist_append(sdi->channels, ch);
112 if (ch_idx == old_idx) {
114 * Didn't create any channels for this hardware output.
115 * This can happen if the device has no measurement capability.
122 for (i = 0; i < device->num_channel_groups; i++) {
123 cgs = &device->channel_groups[i];
124 cg = g_malloc0(sizeof(struct sr_channel_group));
125 cg->name = g_strdup(cgs->name);
126 for (j = 0, mask = 1; j < 64; j++, mask <<= 1) {
127 if (cgs->channel_index_mask & mask) {
128 for (l = sdi->channels; l; l = l->next) {
131 if (pch->hw_output_idx == j)
132 cg->channels = g_slist_append(cg->channels, ch);
136 pcg = g_malloc0(sizeof(struct pps_channel_group));
137 pcg->features = cgs->features;
139 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
142 /* SCPI devices commonly lock the panel keys when accessed remotely. */
143 scpi_cmd(sdi, SCPI_CMD_KEY_UNLOCK);
149 static GSList *scan(GSList *options)
151 return sr_scpi_scan(di->priv, options, probe_device);
154 static GSList *dev_list(void)
156 return ((struct drv_context *)(di->priv))->instances;
159 static int dev_clear(void)
161 return std_dev_clear(di, NULL);
164 static int dev_open(struct sr_dev_inst *sdi)
166 struct sr_scpi_dev_inst *scpi;
168 if (sdi->status != SR_ST_ACTIVE)
172 if (sr_scpi_open(scpi) < 0)
175 sdi->status = SR_ST_ACTIVE;
180 static int dev_close(struct sr_dev_inst *sdi)
182 struct sr_scpi_dev_inst *scpi;
184 if (sdi->status != SR_ST_ACTIVE)
185 return SR_ERR_DEV_CLOSED;
189 scpi_cmd(sdi, SCPI_CMD_KEY_UNLOCK);
191 sdi->status = SR_ST_INACTIVE;
197 static int cleanup(void)
202 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
203 const struct sr_channel_group *cg)
205 struct dev_context *devc;
206 struct sr_scpi_dev_inst *scpi;
207 struct sr_channel *ch;
208 struct pps_channel *pch;
209 const GVariantType *gvtype;
222 * These options only apply to channel groups with a single
223 * channel -- they're per-channel settings for the device.
227 * Config keys are handled below depending on whether a channel
228 * group was provided by the frontend. However some of these
229 * take a CG on one PPS but not on others. Check the device's
230 * profile for that here, and NULL out the channel group as needed.
232 for (i = 0; i < devc->device->num_devopts; i++) {
233 if (devc->device->devopts[i] == key) {
239 ch = cg->channels->data;
246 case SR_CONF_OUTPUT_ENABLED:
247 gvtype = G_VARIANT_TYPE_BOOLEAN;
248 cmd = SCPI_CMD_GET_OUTPUT_ENABLED;
250 case SR_CONF_OUTPUT_VOLTAGE:
251 gvtype = G_VARIANT_TYPE_DOUBLE;
252 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
254 case SR_CONF_OUTPUT_VOLTAGE_MAX:
255 gvtype = G_VARIANT_TYPE_DOUBLE;
256 cmd = SCPI_CMD_GET_VOLTAGE_MAX;
258 case SR_CONF_OUTPUT_CURRENT:
259 gvtype = G_VARIANT_TYPE_DOUBLE;
260 cmd = SCPI_CMD_GET_MEAS_CURRENT;
262 case SR_CONF_OUTPUT_CURRENT_MAX:
263 gvtype = G_VARIANT_TYPE_DOUBLE;
264 cmd = SCPI_CMD_GET_CURRENT_MAX;
266 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
267 gvtype = G_VARIANT_TYPE_BOOLEAN;
268 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED;
270 case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
271 gvtype = G_VARIANT_TYPE_BOOLEAN;
272 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE;
274 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
275 gvtype = G_VARIANT_TYPE_DOUBLE;
276 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD;
278 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
279 gvtype = G_VARIANT_TYPE_BOOLEAN;
280 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED;
282 case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
283 gvtype = G_VARIANT_TYPE_BOOLEAN;
284 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE;
286 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
287 gvtype = G_VARIANT_TYPE_DOUBLE;
288 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD;
290 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
291 gvtype = G_VARIANT_TYPE_BOOLEAN;
292 cmd = SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION;
297 ret = scpi_cmd_resp(sdi, data, gvtype, cmd, pch->hwname);
299 ret = scpi_cmd_resp(sdi, data, gvtype, cmd);
302 case SR_CONF_OUTPUT_REGULATION:
304 if (scpi_cmd(sdi, SCPI_CMD_GET_OUTPUT_REGULATION, pch->hwname) == SR_OK) {
305 if (sr_scpi_get_string(scpi, NULL, &s) == SR_OK) {
306 if (strcmp(s, "CC") && strcmp(s, "CV") && strcmp(s, "UR")) {
307 sr_dbg("Unknown response to SCPI_CMD_GET_OUTPUT_REGULATION: %s", s);
309 *data = g_variant_new_string(s);
325 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
326 const struct sr_channel_group *cg)
328 struct sr_channel *ch;
329 struct pps_channel *pch;
334 if (sdi->status != SR_ST_ACTIVE)
335 return SR_ERR_DEV_CLOSED;
340 /* No channel group: global options. */
341 case SR_CONF_OUTPUT_ENABLED:
342 s = g_variant_get_boolean(data) ? "ON" : "OFF";
343 ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_ENABLED, s);
345 case SR_CONF_OUTPUT_VOLTAGE_MAX:
346 d = g_variant_get_double(data);
347 ret = scpi_cmd(sdi, SCPI_CMD_SET_VOLTAGE_MAX, d);
349 case SR_CONF_OUTPUT_CURRENT_MAX:
350 d = g_variant_get_double(data);
351 ret = scpi_cmd(sdi, SCPI_CMD_SET_CURRENT_MAX, d);
353 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
354 s = g_variant_get_boolean(data) ? "ON" : "OFF";
355 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION, s);
361 /* Channel group specified. */
364 if (g_slist_length(cg->channels) > 1)
366 ch = cg->channels->data;
369 case SR_CONF_OUTPUT_ENABLED:
370 s = g_variant_get_boolean(data) ? "ON" : "OFF";
371 ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_ENABLED, pch->hwname, s);
373 case SR_CONF_OUTPUT_VOLTAGE_MAX:
374 d = g_variant_get_double(data);
375 ret = scpi_cmd(sdi, SCPI_CMD_SET_VOLTAGE_MAX, pch->hwname, d);
377 case SR_CONF_OUTPUT_CURRENT_MAX:
378 d = g_variant_get_double(data);
379 ret = scpi_cmd(sdi, SCPI_CMD_SET_CURRENT_MAX, pch->hwname, d);
381 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
382 s = g_variant_get_boolean(data) ? "ON" : "OFF";
383 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLED,
386 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
387 d = g_variant_get_double(data);
388 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD,
391 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
392 s = g_variant_get_boolean(data) ? "ON" : "OFF";
393 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLED,
396 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
397 d = g_variant_get_double(data);
398 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD,
409 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
410 const struct sr_channel_group *cg)
412 struct dev_context *devc;
413 struct sr_channel *ch;
414 struct channel_spec *ch_spec;
420 /* Always available, even without sdi. */
421 if (key == SR_CONF_SCAN_OPTIONS) {
422 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
423 scanopts, ARRAY_SIZE(scanopts), sizeof(int32_t));
433 /* No channel group: global options. */
435 case SR_CONF_DEVICE_OPTIONS:
436 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
437 devc->device->devopts, devc->device->num_devopts,
440 case SR_CONF_OUTPUT_CHANNEL_CONFIG:
443 if (devc->device->features & PPS_INDEPENDENT)
444 s[i++] = "Independent";
445 if (devc->device->features & PPS_SERIES)
447 if (devc->device->features & PPS_PARALLEL)
451 * Shouldn't happen: independent-only devices
452 * shouldn't advertise this option at all.
456 *data = g_variant_new_strv(s, i);
462 /* Channel group specified. */
464 * Per-channel-group options depending on a channel are actually
465 * done with the first channel. Channel groups in PPS can have
466 * more than one channel, but they will typically be of equal
467 * specification for use in series or parallel mode.
469 ch = cg->channels->data;
472 case SR_CONF_DEVICE_OPTIONS:
473 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
474 devc->device->devopts_cg, devc->device->num_devopts_cg,
477 case SR_CONF_OUTPUT_VOLTAGE_MAX:
478 ch_spec = &(devc->device->channels[ch->index]);
479 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
480 /* Min, max, write resolution. */
481 for (i = 0; i < 3; i++) {
482 gvar = g_variant_new_double(ch_spec->voltage[i]);
483 g_variant_builder_add_value(&gvb, gvar);
485 *data = g_variant_builder_end(&gvb);
487 case SR_CONF_OUTPUT_CURRENT_MAX:
488 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
489 /* Min, max, step. */
490 for (i = 0; i < 3; i++) {
491 ch_spec = &(devc->device->channels[ch->index]);
492 gvar = g_variant_new_double(ch_spec->current[i]);
493 g_variant_builder_add_value(&gvb, gvar);
495 *data = g_variant_builder_end(&gvb);
505 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
508 struct dev_context *devc;
509 struct sr_scpi_dev_inst *scpi;
510 struct sr_channel *ch;
511 struct pps_channel *pch;
514 if (sdi->status != SR_ST_ACTIVE)
515 return SR_ERR_DEV_CLOSED;
519 devc->cb_data = cb_data;
521 if ((ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
522 scpi_pps_receive_data, (void *)sdi)) != SR_OK)
524 std_session_send_df_header(sdi, LOG_PREFIX);
526 /* Prime the pipe with the first channel's fetch. */
527 ch = sdi->channels->data;
529 devc->cur_channel = ch;
530 if (pch->mq == SR_MQ_VOLTAGE)
531 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
532 else if (pch->mq == SR_MQ_CURRENT)
533 cmd = SCPI_CMD_GET_MEAS_CURRENT;
534 else if (pch->mq == SR_MQ_POWER)
535 cmd = SCPI_CMD_GET_MEAS_POWER;
538 scpi_cmd(sdi, cmd, pch->hwname);
543 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
545 struct sr_scpi_dev_inst *scpi;
550 if (sdi->status != SR_ST_ACTIVE)
551 return SR_ERR_DEV_CLOSED;
556 * A requested value is certainly on the way. Retrieve it now,
557 * to avoid leaving the device in a state where it's not expecting
560 sr_scpi_get_float(scpi, NULL, &f);
561 sr_scpi_source_remove(sdi->session, scpi);
566 SR_PRIV struct sr_dev_driver scpi_pps_driver_info = {
568 .longname = "SCPI PPS",
573 .dev_list = dev_list,
574 .dev_clear = dev_clear,
575 .config_get = config_get,
576 .config_set = config_set,
577 .config_list = config_list,
578 .dev_open = dev_open,
579 .dev_close = dev_close,
580 .dev_acquisition_start = dev_acquisition_start,
581 .dev_acquisition_stop = dev_acquisition_stop,