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/>.
26 SR_PRIV struct sr_dev_driver scpi_pps_driver_info;
28 static const uint32_t scanopts[] = {
33 static const uint32_t drvopts[] = {
37 static const struct pps_channel_instance pci[] = {
38 { SR_MQ_VOLTAGE, SCPI_CMD_GET_MEAS_VOLTAGE, "V" },
39 { SR_MQ_CURRENT, SCPI_CMD_GET_MEAS_CURRENT, "I" },
40 { SR_MQ_POWER, SCPI_CMD_GET_MEAS_POWER, "P" },
41 { SR_MQ_FREQUENCY, SCPI_CMD_GET_MEAS_FREQUENCY, "F" },
44 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
46 return std_init(sr_ctx, di, LOG_PREFIX);
49 static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
51 struct dev_context *devc;
52 struct sr_dev_inst *sdi;
53 struct sr_scpi_hw_info *hw_info;
54 struct sr_channel_group *cg;
55 struct sr_channel *ch;
56 const struct scpi_pps *device;
57 struct pps_channel *pch;
58 struct channel_spec *channels;
59 struct channel_group_spec *channel_groups, *cgs;
60 struct pps_channel_group *pcg;
65 unsigned int num_channels, num_channel_groups, ch_num, ch_idx, i, j;
70 if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
71 sr_info("Couldn't get IDN response.");
76 for (i = 0; i < num_pps_profiles; i++) {
77 vendor = sr_vendor_alias(hw_info->manufacturer);
78 if (g_ascii_strcasecmp(vendor, pps_profiles[i].vendor))
80 model_re = g_regex_new(pps_profiles[i].model, 0, 0, NULL);
81 if (g_regex_match(model_re, hw_info->model, 0, &model_mi))
82 device = &pps_profiles[i];
83 g_match_info_unref(model_mi);
84 g_regex_unref(model_re);
89 sr_scpi_hw_info_free(hw_info);
93 sdi = g_malloc0(sizeof(struct sr_dev_inst));
94 sdi->vendor = g_strdup(vendor);
95 sdi->model = g_strdup(hw_info->model);
96 sdi->version = g_strdup(hw_info->firmware_version);
98 sdi->driver = &scpi_pps_driver_info;
99 sdi->inst_type = SR_INST_SCPI;
100 sdi->serial_num = g_strdup(hw_info->serial_number);
102 devc = g_malloc0(sizeof(struct dev_context));
103 devc->device = device;
106 if (device->num_channels) {
107 /* Static channels and groups. */
108 channels = (struct channel_spec *)device->channels;
109 num_channels = device->num_channels;
110 channel_groups = (struct channel_group_spec *)device->channel_groups;
111 num_channel_groups = device->num_channel_groups;
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);
117 sr_err("Failed to probe for channels.");
121 * Since these were dynamically allocated, we'll need to free them
124 devc->channels = channels;
125 devc->channel_groups = channel_groups;
129 for (ch_num = 0; ch_num < num_channels; ch_num++) {
130 /* Create one channel per measurable output unit. */
131 for (i = 0; i < ARRAY_SIZE(pci); i++) {
132 if (!scpi_cmd_get(devc->device->commands, pci[i].command))
134 g_snprintf(ch_name, 16, "%s%s", pci[i].prefix,
135 channels[ch_num].name);
136 ch = sr_channel_new(sdi, ch_idx++, SR_CHANNEL_ANALOG, TRUE,
138 pch = g_malloc0(sizeof(struct pps_channel));
139 pch->hw_output_idx = ch_num;
140 pch->hwname = channels[ch_num].name;
146 for (i = 0; i < num_channel_groups; i++) {
147 cgs = &channel_groups[i];
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) {
152 for (l = sdi->channels; l; l = l->next) {
155 if (pch->hw_output_idx == j)
156 cg->channels = g_slist_append(cg->channels, ch);
160 pcg = g_malloc0(sizeof(struct pps_channel_group));
161 pcg->features = cgs->features;
163 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
166 sr_scpi_hw_info_free(hw_info);
169 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_LOCAL);
174 static GSList *scan(struct sr_dev_driver *di, GSList *options)
176 return sr_scpi_scan(di->context, options, probe_device);
179 static GSList *dev_list(const struct sr_dev_driver *di)
181 return ((struct drv_context *)(di->context))->instances;
184 static int dev_open(struct sr_dev_inst *sdi)
186 struct dev_context *devc;
187 struct sr_scpi_dev_inst *scpi;
190 if (sdi->status != SR_ST_INACTIVE)
194 if (sr_scpi_open(scpi) < 0)
197 sdi->status = SR_ST_ACTIVE;
200 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_REMOTE);
201 devc->beeper_was_set = FALSE;
202 if (scpi_cmd_resp(sdi, devc->device->commands, &beeper,
203 G_VARIANT_TYPE_BOOLEAN, SCPI_CMD_BEEPER) == SR_OK) {
204 if (g_variant_get_boolean(beeper)) {
205 devc->beeper_was_set = TRUE;
206 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_BEEPER_DISABLE);
208 g_variant_unref(beeper);
214 static int dev_close(struct sr_dev_inst *sdi)
216 struct sr_scpi_dev_inst *scpi;
217 struct dev_context *devc;
219 if (sdi->status != SR_ST_ACTIVE)
220 return SR_ERR_DEV_CLOSED;
225 if (devc->beeper_was_set)
226 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_BEEPER_ENABLE);
227 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_LOCAL);
229 sdi->status = SR_ST_INACTIVE;
235 static void clear_helper(void *priv)
237 struct dev_context *devc;
240 g_free(devc->channels);
241 g_free(devc->channel_groups);
245 static int dev_clear(const struct sr_dev_driver *di)
247 return std_dev_clear(di, clear_helper);
250 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
251 const struct sr_channel_group *cg)
253 struct dev_context *devc;
254 const GVariantType *gvtype;
266 * These options only apply to channel groups with a single
267 * channel -- they're per-channel settings for the device.
271 * Config keys are handled below depending on whether a channel
272 * group was provided by the frontend. However some of these
273 * take a CG on one PPS but not on others. Check the device's
274 * profile for that here, and NULL out the channel group as needed.
276 for (i = 0; i < devc->device->num_devopts; i++) {
277 if (devc->device->devopts[i] == key) {
287 case SR_CONF_ENABLED:
288 gvtype = G_VARIANT_TYPE_BOOLEAN;
289 cmd = SCPI_CMD_GET_OUTPUT_ENABLED;
291 case SR_CONF_VOLTAGE:
292 gvtype = G_VARIANT_TYPE_DOUBLE;
293 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
295 case SR_CONF_VOLTAGE_TARGET:
296 gvtype = G_VARIANT_TYPE_DOUBLE;
297 cmd = SCPI_CMD_GET_VOLTAGE_TARGET;
299 case SR_CONF_OUTPUT_FREQUENCY:
300 gvtype = G_VARIANT_TYPE_DOUBLE;
301 cmd = SCPI_CMD_GET_MEAS_FREQUENCY;
303 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
304 gvtype = G_VARIANT_TYPE_DOUBLE;
305 cmd = SCPI_CMD_GET_FREQUENCY_TARGET;
307 case SR_CONF_CURRENT:
308 gvtype = G_VARIANT_TYPE_DOUBLE;
309 cmd = SCPI_CMD_GET_MEAS_CURRENT;
311 case SR_CONF_CURRENT_LIMIT:
312 gvtype = G_VARIANT_TYPE_DOUBLE;
313 cmd = SCPI_CMD_GET_CURRENT_LIMIT;
315 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
316 gvtype = G_VARIANT_TYPE_BOOLEAN;
317 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED;
319 case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
320 gvtype = G_VARIANT_TYPE_BOOLEAN;
321 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE;
323 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
324 gvtype = G_VARIANT_TYPE_DOUBLE;
325 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD;
327 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
328 gvtype = G_VARIANT_TYPE_BOOLEAN;
329 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED;
331 case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
332 gvtype = G_VARIANT_TYPE_BOOLEAN;
333 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE;
335 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
336 gvtype = G_VARIANT_TYPE_DOUBLE;
337 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD;
339 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
340 gvtype = G_VARIANT_TYPE_BOOLEAN;
341 cmd = SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION;
343 case SR_CONF_REGULATION:
344 gvtype = G_VARIANT_TYPE_STRING;
345 cmd = SCPI_CMD_GET_OUTPUT_REGULATION;
351 select_channel(sdi, cg->channels->data);
352 ret = scpi_cmd_resp(sdi, devc->device->commands, data, gvtype, cmd);
354 if (cmd == SCPI_CMD_GET_OUTPUT_REGULATION) {
356 * The Rigol DP800 series return CV/CC/UR, Philips PM2800
357 * return VOLT/CURR. We always return a GVariant string in
358 * the Rigol notation.
360 s = g_variant_get_string(*data, NULL);
361 if (!strcmp(s, "VOLT")) {
362 g_variant_unref(*data);
363 *data = g_variant_new_string("CV");
364 } else if (!strcmp(s, "CURR")) {
365 g_variant_unref(*data);
366 *data = g_variant_new_string("CC");
369 s = g_variant_get_string(*data, NULL);
370 if (strcmp(s, "CV") && strcmp(s, "CC") && strcmp(s, "UR")) {
371 sr_dbg("Unknown response to SCPI_CMD_GET_OUTPUT_REGULATION: %s", s);
379 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
380 const struct sr_channel_group *cg)
382 struct dev_context *devc;
389 if (sdi->status != SR_ST_ACTIVE)
390 return SR_ERR_DEV_CLOSED;
393 /* Channel group specified. */
394 select_channel(sdi, cg->channels->data);
399 case SR_CONF_ENABLED:
400 if (g_variant_get_boolean(data))
401 ret = scpi_cmd(sdi, devc->device->commands,
402 SCPI_CMD_SET_OUTPUT_ENABLE);
404 ret = scpi_cmd(sdi, devc->device->commands,
405 SCPI_CMD_SET_OUTPUT_DISABLE);
407 case SR_CONF_VOLTAGE_TARGET:
408 d = g_variant_get_double(data);
409 ret = scpi_cmd(sdi, devc->device->commands,
410 SCPI_CMD_SET_VOLTAGE_TARGET, d);
412 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
413 d = g_variant_get_double(data);
414 ret = scpi_cmd(sdi, devc->device->commands,
415 SCPI_CMD_SET_FREQUENCY_TARGET, d);
417 case SR_CONF_CURRENT_LIMIT:
418 d = g_variant_get_double(data);
419 ret = scpi_cmd(sdi, devc->device->commands,
420 SCPI_CMD_SET_CURRENT_LIMIT, d);
422 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
423 if (g_variant_get_boolean(data))
424 ret = scpi_cmd(sdi, devc->device->commands,
425 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLE);
427 ret = scpi_cmd(sdi, devc->device->commands,
428 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_DISABLE);
430 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
431 d = g_variant_get_double(data);
432 ret = scpi_cmd(sdi, devc->device->commands,
433 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD, d);
435 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
436 if (g_variant_get_boolean(data))
437 ret = scpi_cmd(sdi, devc->device->commands,
438 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLE);
440 ret = scpi_cmd(sdi, devc->device->commands,
441 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_DISABLE);
443 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
444 d = g_variant_get_double(data);
445 ret = scpi_cmd(sdi, devc->device->commands,
446 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD, d);
448 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
449 if (g_variant_get_boolean(data))
450 ret = scpi_cmd(sdi, devc->device->commands,
451 SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_ENABLE);
453 ret = scpi_cmd(sdi, devc->device->commands,
454 SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_DISABLE);
463 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
464 const struct sr_channel_group *cg)
466 struct dev_context *devc;
467 struct sr_channel *ch;
468 const struct channel_spec *ch_spec;
474 /* Always available, even without sdi. */
475 if (key == SR_CONF_SCAN_OPTIONS) {
476 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
477 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
479 } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
480 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
481 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
491 /* No channel group: global options. */
493 case SR_CONF_DEVICE_OPTIONS:
494 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
495 devc->device->devopts, devc->device->num_devopts,
498 case SR_CONF_CHANNEL_CONFIG:
501 if (devc->device->features & PPS_INDEPENDENT)
502 s[i++] = "Independent";
503 if (devc->device->features & PPS_SERIES)
505 if (devc->device->features & PPS_PARALLEL)
509 * Shouldn't happen: independent-only devices
510 * shouldn't advertise this option at all.
514 *data = g_variant_new_strv(s, i);
520 /* Channel group specified. */
522 * Per-channel-group options depending on a channel are actually
523 * done with the first channel. Channel groups in PPS can have
524 * more than one channel, but they will typically be of equal
525 * specification for use in series or parallel mode.
527 ch = cg->channels->data;
530 case SR_CONF_DEVICE_OPTIONS:
531 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
532 devc->device->devopts_cg, devc->device->num_devopts_cg,
535 case SR_CONF_VOLTAGE_TARGET:
536 ch_spec = &(devc->device->channels[ch->index]);
537 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
538 /* Min, max, write resolution. */
539 for (i = 0; i < 3; i++) {
540 gvar = g_variant_new_double(ch_spec->voltage[i]);
541 g_variant_builder_add_value(&gvb, gvar);
543 *data = g_variant_builder_end(&gvb);
545 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
546 ch_spec = &(devc->device->channels[ch->index]);
547 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
548 /* Min, max, write resolution. */
549 for (i = 0; i < 3; i++) {
550 gvar = g_variant_new_double(ch_spec->frequency[i]);
551 g_variant_builder_add_value(&gvb, gvar);
553 *data = g_variant_builder_end(&gvb);
555 case SR_CONF_CURRENT_LIMIT:
556 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
557 /* Min, max, step. */
558 for (i = 0; i < 3; i++) {
559 ch_spec = &(devc->device->channels[ch->index]);
560 gvar = g_variant_new_double(ch_spec->current[i]);
561 g_variant_builder_add_value(&gvb, gvar);
563 *data = g_variant_builder_end(&gvb);
573 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
575 struct dev_context *devc;
576 struct sr_scpi_dev_inst *scpi;
577 struct sr_channel *ch;
578 struct pps_channel *pch;
581 if (sdi->status != SR_ST_ACTIVE)
582 return SR_ERR_DEV_CLOSED;
587 if ((ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
588 scpi_pps_receive_data, (void *)sdi)) != SR_OK)
590 std_session_send_df_header(sdi, LOG_PREFIX);
592 /* Prime the pipe with the first channel's fetch. */
593 ch = sr_next_enabled_channel(sdi, NULL);
595 if ((ret = select_channel(sdi, ch)) < 0)
597 if (pch->mq == SR_MQ_VOLTAGE)
598 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
599 else if (pch->mq == SR_MQ_FREQUENCY)
600 cmd = SCPI_CMD_GET_MEAS_FREQUENCY;
601 else if (pch->mq == SR_MQ_CURRENT)
602 cmd = SCPI_CMD_GET_MEAS_CURRENT;
603 else if (pch->mq == SR_MQ_POWER)
604 cmd = SCPI_CMD_GET_MEAS_POWER;
607 scpi_cmd(sdi, devc->device->commands, cmd, pch->hwname);
612 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
614 struct sr_scpi_dev_inst *scpi;
617 if (sdi->status != SR_ST_ACTIVE)
618 return SR_ERR_DEV_CLOSED;
623 * A requested value is certainly on the way. Retrieve it now,
624 * to avoid leaving the device in a state where it's not expecting
627 sr_scpi_get_float(scpi, NULL, &f);
628 sr_scpi_source_remove(sdi->session, scpi);
630 std_session_send_df_end(sdi, LOG_PREFIX);
635 SR_PRIV struct sr_dev_driver scpi_pps_driver_info = {
637 .longname = "SCPI PPS",
640 .cleanup = std_cleanup,
642 .dev_list = dev_list,
643 .dev_clear = dev_clear,
644 .config_get = config_get,
645 .config_set = config_set,
646 .config_list = config_list,
647 .dev_open = dev_open,
648 .dev_close = dev_close,
649 .dev_acquisition_start = dev_acquisition_start,
650 .dev_acquisition_stop = dev_acquisition_stop,