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 uint32_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, 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. */
98 for (i = 0; i < ARRAY_SIZE(pci); i++) {
99 if (!scpi_cmd_get(sdi, pci[i].command))
101 g_snprintf(ch_name, 16, "%s%s", pci[i].prefix,
102 device->channels[ch_num].name);
103 ch = sr_channel_new(ch_idx++, SR_CHANNEL_ANALOG, TRUE, ch_name);
104 pch = g_malloc0(sizeof(struct pps_channel));
105 pch->hw_output_idx = ch_num;
106 pch->hwname = device->channels[ch_num].name;
109 sdi->channels = g_slist_append(sdi->channels, ch);
113 for (i = 0; i < device->num_channel_groups; i++) {
114 cgs = &device->channel_groups[i];
115 cg = g_malloc0(sizeof(struct sr_channel_group));
116 cg->name = g_strdup(cgs->name);
117 for (j = 0, mask = 1; j < 64; j++, mask <<= 1) {
118 if (cgs->channel_index_mask & mask) {
119 for (l = sdi->channels; l; l = l->next) {
122 if (pch->hw_output_idx == j)
123 cg->channels = g_slist_append(cg->channels, ch);
127 pcg = g_malloc0(sizeof(struct pps_channel_group));
128 pcg->features = cgs->features;
130 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
133 /* SCPI devices commonly lock the panel keys when accessed remotely. */
134 scpi_cmd(sdi, SCPI_CMD_KEY_UNLOCK);
140 static GSList *scan(GSList *options)
142 return sr_scpi_scan(di->priv, options, probe_device);
145 static GSList *dev_list(void)
147 return ((struct drv_context *)(di->priv))->instances;
150 static int dev_clear(void)
152 return std_dev_clear(di, NULL);
155 static int dev_open(struct sr_dev_inst *sdi)
157 struct sr_scpi_dev_inst *scpi;
159 if (sdi->status != SR_ST_ACTIVE)
163 if (sr_scpi_open(scpi) < 0)
166 sdi->status = SR_ST_ACTIVE;
171 static int dev_close(struct sr_dev_inst *sdi)
173 struct sr_scpi_dev_inst *scpi;
175 if (sdi->status != SR_ST_ACTIVE)
176 return SR_ERR_DEV_CLOSED;
180 scpi_cmd(sdi, SCPI_CMD_KEY_UNLOCK);
182 sdi->status = SR_ST_INACTIVE;
188 static int cleanup(void)
193 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
194 const struct sr_channel_group *cg)
196 struct dev_context *devc;
197 struct sr_scpi_dev_inst *scpi;
198 struct sr_channel *ch;
199 struct pps_channel *pch;
200 const GVariantType *gvtype;
213 * These options only apply to channel groups with a single
214 * channel -- they're per-channel settings for the device.
218 * Config keys are handled below depending on whether a channel
219 * group was provided by the frontend. However some of these
220 * take a CG on one PPS but not on others. Check the device's
221 * profile for that here, and NULL out the channel group as needed.
223 for (i = 0; i < devc->device->num_devopts; i++) {
224 if (devc->device->devopts[i] == key) {
230 ch = cg->channels->data;
237 case SR_CONF_OUTPUT_ENABLED:
238 gvtype = G_VARIANT_TYPE_BOOLEAN;
239 cmd = SCPI_CMD_GET_OUTPUT_ENABLED;
241 case SR_CONF_OUTPUT_VOLTAGE:
242 gvtype = G_VARIANT_TYPE_DOUBLE;
243 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
245 case SR_CONF_OUTPUT_VOLTAGE_MAX:
246 gvtype = G_VARIANT_TYPE_DOUBLE;
247 cmd = SCPI_CMD_GET_VOLTAGE_MAX;
249 case SR_CONF_OUTPUT_CURRENT:
250 gvtype = G_VARIANT_TYPE_DOUBLE;
251 cmd = SCPI_CMD_GET_MEAS_CURRENT;
253 case SR_CONF_OUTPUT_CURRENT_MAX:
254 gvtype = G_VARIANT_TYPE_DOUBLE;
255 cmd = SCPI_CMD_GET_CURRENT_MAX;
257 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
258 gvtype = G_VARIANT_TYPE_BOOLEAN;
259 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED;
261 case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
262 gvtype = G_VARIANT_TYPE_BOOLEAN;
263 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE;
265 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
266 gvtype = G_VARIANT_TYPE_DOUBLE;
267 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD;
269 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
270 gvtype = G_VARIANT_TYPE_BOOLEAN;
271 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED;
273 case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
274 gvtype = G_VARIANT_TYPE_BOOLEAN;
275 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE;
277 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
278 gvtype = G_VARIANT_TYPE_DOUBLE;
279 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD;
281 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
282 gvtype = G_VARIANT_TYPE_BOOLEAN;
283 cmd = SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION;
288 ret = scpi_cmd_resp(sdi, data, gvtype, cmd, pch->hwname);
290 ret = scpi_cmd_resp(sdi, data, gvtype, cmd);
293 case SR_CONF_OUTPUT_REGULATION:
295 if (scpi_cmd(sdi, SCPI_CMD_GET_OUTPUT_REGULATION, pch->hwname) == SR_OK) {
296 if (sr_scpi_get_string(scpi, NULL, &s) == SR_OK) {
297 if (strcmp(s, "CC") && strcmp(s, "CV") && strcmp(s, "UR")) {
298 sr_dbg("Unknown response to SCPI_CMD_GET_OUTPUT_REGULATION: %s", s);
300 *data = g_variant_new_string(s);
316 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
317 const struct sr_channel_group *cg)
319 struct sr_channel *ch;
320 struct pps_channel *pch;
328 if (sdi->status != SR_ST_ACTIVE)
329 return SR_ERR_DEV_CLOSED;
334 /* No channel group: global options. */
335 case SR_CONF_OUTPUT_ENABLED:
336 s = g_variant_get_boolean(data) ? "ON" : "OFF";
337 ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_ENABLED, s);
339 case SR_CONF_OUTPUT_VOLTAGE_MAX:
340 d = g_variant_get_double(data);
341 ret = scpi_cmd(sdi, SCPI_CMD_SET_VOLTAGE_MAX, d);
343 case SR_CONF_OUTPUT_CURRENT_MAX:
344 d = g_variant_get_double(data);
345 ret = scpi_cmd(sdi, SCPI_CMD_SET_CURRENT_MAX, d);
347 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
348 s = g_variant_get_boolean(data) ? "ON" : "OFF";
349 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION, s);
355 /* Channel group specified. */
356 ch = cg->channels->data;
359 case SR_CONF_OUTPUT_ENABLED:
360 s = g_variant_get_boolean(data) ? "ON" : "OFF";
361 ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_ENABLED, pch->hwname, s);
363 case SR_CONF_OUTPUT_VOLTAGE_MAX:
364 d = g_variant_get_double(data);
365 ret = scpi_cmd(sdi, SCPI_CMD_SET_VOLTAGE_MAX, pch->hwname, d);
367 case SR_CONF_OUTPUT_CURRENT_MAX:
368 d = g_variant_get_double(data);
369 ret = scpi_cmd(sdi, SCPI_CMD_SET_CURRENT_MAX, pch->hwname, d);
371 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
372 s = g_variant_get_boolean(data) ? "ON" : "OFF";
373 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLED,
376 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
377 d = g_variant_get_double(data);
378 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD,
381 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
382 s = g_variant_get_boolean(data) ? "ON" : "OFF";
383 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLED,
386 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
387 d = g_variant_get_double(data);
388 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD,
399 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
400 const struct sr_channel_group *cg)
402 struct dev_context *devc;
403 struct sr_channel *ch;
404 struct channel_spec *ch_spec;
410 /* Always available, even without sdi. */
411 if (key == SR_CONF_SCAN_OPTIONS) {
412 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
413 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
423 /* No channel group: global options. */
425 case SR_CONF_DEVICE_OPTIONS:
426 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
427 devc->device->devopts, devc->device->num_devopts,
430 case SR_CONF_OUTPUT_CHANNEL_CONFIG:
433 if (devc->device->features & PPS_INDEPENDENT)
434 s[i++] = "Independent";
435 if (devc->device->features & PPS_SERIES)
437 if (devc->device->features & PPS_PARALLEL)
441 * Shouldn't happen: independent-only devices
442 * shouldn't advertise this option at all.
446 *data = g_variant_new_strv(s, i);
452 /* Channel group specified. */
454 * Per-channel-group options depending on a channel are actually
455 * done with the first channel. Channel groups in PPS can have
456 * more than one channel, but they will typically be of equal
457 * specification for use in series or parallel mode.
459 ch = cg->channels->data;
462 case SR_CONF_DEVICE_OPTIONS:
463 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
464 devc->device->devopts_cg, devc->device->num_devopts_cg,
467 case SR_CONF_OUTPUT_VOLTAGE_MAX:
468 ch_spec = &(devc->device->channels[ch->index]);
469 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
470 /* Min, max, write resolution. */
471 for (i = 0; i < 3; i++) {
472 gvar = g_variant_new_double(ch_spec->voltage[i]);
473 g_variant_builder_add_value(&gvb, gvar);
475 *data = g_variant_builder_end(&gvb);
477 case SR_CONF_OUTPUT_CURRENT_MAX:
478 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
479 /* Min, max, step. */
480 for (i = 0; i < 3; i++) {
481 ch_spec = &(devc->device->channels[ch->index]);
482 gvar = g_variant_new_double(ch_spec->current[i]);
483 g_variant_builder_add_value(&gvb, gvar);
485 *data = g_variant_builder_end(&gvb);
495 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
498 struct dev_context *devc;
499 struct sr_scpi_dev_inst *scpi;
500 struct sr_channel *ch;
501 struct pps_channel *pch;
504 if (sdi->status != SR_ST_ACTIVE)
505 return SR_ERR_DEV_CLOSED;
509 devc->cb_data = cb_data;
511 if ((ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
512 scpi_pps_receive_data, (void *)sdi)) != SR_OK)
514 std_session_send_df_header(sdi, LOG_PREFIX);
516 /* Prime the pipe with the first channel's fetch. */
517 ch = sdi->channels->data;
519 devc->cur_channel = ch;
520 if (pch->mq == SR_MQ_VOLTAGE)
521 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
522 else if (pch->mq == SR_MQ_CURRENT)
523 cmd = SCPI_CMD_GET_MEAS_CURRENT;
524 else if (pch->mq == SR_MQ_POWER)
525 cmd = SCPI_CMD_GET_MEAS_POWER;
528 scpi_cmd(sdi, cmd, pch->hwname);
533 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
535 struct sr_scpi_dev_inst *scpi;
540 if (sdi->status != SR_ST_ACTIVE)
541 return SR_ERR_DEV_CLOSED;
546 * A requested value is certainly on the way. Retrieve it now,
547 * to avoid leaving the device in a state where it's not expecting
550 sr_scpi_get_float(scpi, NULL, &f);
551 sr_scpi_source_remove(sdi->session, scpi);
556 SR_PRIV struct sr_dev_driver scpi_pps_driver_info = {
558 .longname = "SCPI PPS",
563 .dev_list = dev_list,
564 .dev_clear = dev_clear,
565 .config_get = config_get,
566 .config_set = config_set,
567 .config_list = config_list,
568 .dev_open = dev_open,
569 .dev_close = dev_close,
570 .dev_acquisition_start = dev_acquisition_start,
571 .dev_acquisition_stop = dev_acquisition_stop,