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_clear(const struct sr_dev_driver *di)
186 return std_dev_clear(di, NULL);
189 static int dev_open(struct sr_dev_inst *sdi)
191 struct dev_context *devc;
192 struct sr_scpi_dev_inst *scpi;
195 if (sdi->status != SR_ST_INACTIVE)
199 if (sr_scpi_open(scpi) < 0)
202 sdi->status = SR_ST_ACTIVE;
205 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_REMOTE);
207 devc->beeper_was_set = FALSE;
208 if (scpi_cmd_resp(sdi, devc->device->commands, &beeper,
209 G_VARIANT_TYPE_BOOLEAN, SCPI_CMD_BEEPER) == SR_OK) {
210 if (g_variant_get_boolean(beeper)) {
211 devc->beeper_was_set = TRUE;
212 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_BEEPER_DISABLE);
214 g_variant_unref(beeper);
220 static int dev_close(struct sr_dev_inst *sdi)
222 struct sr_scpi_dev_inst *scpi;
223 struct dev_context *devc;
225 if (sdi->status != SR_ST_ACTIVE)
226 return SR_ERR_DEV_CLOSED;
231 if (devc->beeper_was_set)
232 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_BEEPER_ENABLE);
233 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_LOCAL);
235 sdi->status = SR_ST_INACTIVE;
241 static void clear_helper(void *priv)
243 struct dev_context *devc;
246 g_free(devc->channels);
247 g_free(devc->channel_groups);
251 static int cleanup(const struct sr_dev_driver *di)
253 return std_dev_clear(di, clear_helper);
256 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
257 const struct sr_channel_group *cg)
259 struct dev_context *devc;
260 const GVariantType *gvtype;
272 * These options only apply to channel groups with a single
273 * channel -- they're per-channel settings for the device.
277 * Config keys are handled below depending on whether a channel
278 * group was provided by the frontend. However some of these
279 * take a CG on one PPS but not on others. Check the device's
280 * profile for that here, and NULL out the channel group as needed.
282 for (i = 0; i < devc->device->num_devopts; i++) {
283 if (devc->device->devopts[i] == key) {
293 case SR_CONF_ENABLED:
294 gvtype = G_VARIANT_TYPE_BOOLEAN;
295 cmd = SCPI_CMD_GET_OUTPUT_ENABLED;
297 case SR_CONF_VOLTAGE:
298 gvtype = G_VARIANT_TYPE_DOUBLE;
299 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
301 case SR_CONF_VOLTAGE_TARGET:
302 gvtype = G_VARIANT_TYPE_DOUBLE;
303 cmd = SCPI_CMD_GET_VOLTAGE_TARGET;
305 case SR_CONF_OUTPUT_FREQUENCY:
306 gvtype = G_VARIANT_TYPE_DOUBLE;
307 cmd = SCPI_CMD_GET_MEAS_FREQUENCY;
309 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
310 gvtype = G_VARIANT_TYPE_DOUBLE;
311 cmd = SCPI_CMD_GET_FREQUENCY_TARGET;
313 case SR_CONF_CURRENT:
314 gvtype = G_VARIANT_TYPE_DOUBLE;
315 cmd = SCPI_CMD_GET_MEAS_CURRENT;
317 case SR_CONF_CURRENT_LIMIT:
318 gvtype = G_VARIANT_TYPE_DOUBLE;
319 cmd = SCPI_CMD_GET_CURRENT_LIMIT;
321 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
322 gvtype = G_VARIANT_TYPE_BOOLEAN;
323 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED;
325 case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
326 gvtype = G_VARIANT_TYPE_BOOLEAN;
327 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE;
329 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
330 gvtype = G_VARIANT_TYPE_DOUBLE;
331 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD;
333 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
334 gvtype = G_VARIANT_TYPE_BOOLEAN;
335 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED;
337 case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
338 gvtype = G_VARIANT_TYPE_BOOLEAN;
339 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE;
341 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
342 gvtype = G_VARIANT_TYPE_DOUBLE;
343 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD;
345 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
346 gvtype = G_VARIANT_TYPE_BOOLEAN;
347 cmd = SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION;
349 case SR_CONF_REGULATION:
350 gvtype = G_VARIANT_TYPE_STRING;
351 cmd = SCPI_CMD_GET_OUTPUT_REGULATION;
357 select_channel(sdi, cg->channels->data);
358 ret = scpi_cmd_resp(sdi, devc->device->commands, data, gvtype, cmd);
360 if (cmd == SCPI_CMD_GET_OUTPUT_REGULATION) {
362 * The Rigol DP800 series return CV/CC/UR, Philips PM2800
363 * return VOLT/CURR. We always return a GVariant string in
364 * the Rigol notation.
366 s = g_variant_get_string(*data, NULL);
367 if (!strcmp(s, "VOLT")) {
368 g_variant_unref(*data);
369 *data = g_variant_new_string("CV");
370 } else if (!strcmp(s, "CURR")) {
371 g_variant_unref(*data);
372 *data = g_variant_new_string("CC");
375 s = g_variant_get_string(*data, NULL);
376 if (strcmp(s, "CV") && strcmp(s, "CC") && strcmp(s, "UR")) {
377 sr_dbg("Unknown response to SCPI_CMD_GET_OUTPUT_REGULATION: %s", s);
385 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
386 const struct sr_channel_group *cg)
388 struct dev_context *devc;
395 if (sdi->status != SR_ST_ACTIVE)
396 return SR_ERR_DEV_CLOSED;
399 /* Channel group specified. */
400 select_channel(sdi, cg->channels->data);
405 case SR_CONF_ENABLED:
406 if (g_variant_get_boolean(data))
407 ret = scpi_cmd(sdi, devc->device->commands,
408 SCPI_CMD_SET_OUTPUT_ENABLE);
410 ret = scpi_cmd(sdi, devc->device->commands,
411 SCPI_CMD_SET_OUTPUT_DISABLE);
413 case SR_CONF_VOLTAGE_TARGET:
414 d = g_variant_get_double(data);
415 ret = scpi_cmd(sdi, devc->device->commands,
416 SCPI_CMD_SET_VOLTAGE_TARGET, d);
418 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
419 d = g_variant_get_double(data);
420 ret = scpi_cmd(sdi, devc->device->commands,
421 SCPI_CMD_SET_FREQUENCY_TARGET, d);
423 case SR_CONF_CURRENT_LIMIT:
424 d = g_variant_get_double(data);
425 ret = scpi_cmd(sdi, devc->device->commands,
426 SCPI_CMD_SET_CURRENT_LIMIT, d);
428 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
429 if (g_variant_get_boolean(data))
430 ret = scpi_cmd(sdi, devc->device->commands,
431 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLE);
433 ret = scpi_cmd(sdi, devc->device->commands,
434 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_DISABLE);
436 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
437 d = g_variant_get_double(data);
438 ret = scpi_cmd(sdi, devc->device->commands,
439 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD, d);
441 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
442 if (g_variant_get_boolean(data))
443 ret = scpi_cmd(sdi, devc->device->commands,
444 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLE);
446 ret = scpi_cmd(sdi, devc->device->commands,
447 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_DISABLE);
449 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
450 d = g_variant_get_double(data);
451 ret = scpi_cmd(sdi, devc->device->commands,
452 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD, d);
454 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
455 if (g_variant_get_boolean(data))
456 ret = scpi_cmd(sdi, devc->device->commands,
457 SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_ENABLE);
459 ret = scpi_cmd(sdi, devc->device->commands,
460 SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_DISABLE);
469 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
470 const struct sr_channel_group *cg)
472 struct dev_context *devc;
473 struct sr_channel *ch;
474 const struct channel_spec *ch_spec;
480 /* Always available, even without sdi. */
481 if (key == SR_CONF_SCAN_OPTIONS) {
482 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
483 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
485 } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
486 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
487 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
497 /* No channel group: global options. */
499 case SR_CONF_DEVICE_OPTIONS:
500 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
501 devc->device->devopts, devc->device->num_devopts,
504 case SR_CONF_CHANNEL_CONFIG:
507 if (devc->device->features & PPS_INDEPENDENT)
508 s[i++] = "Independent";
509 if (devc->device->features & PPS_SERIES)
511 if (devc->device->features & PPS_PARALLEL)
515 * Shouldn't happen: independent-only devices
516 * shouldn't advertise this option at all.
520 *data = g_variant_new_strv(s, i);
526 /* Channel group specified. */
528 * Per-channel-group options depending on a channel are actually
529 * done with the first channel. Channel groups in PPS can have
530 * more than one channel, but they will typically be of equal
531 * specification for use in series or parallel mode.
533 ch = cg->channels->data;
536 case SR_CONF_DEVICE_OPTIONS:
537 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
538 devc->device->devopts_cg, devc->device->num_devopts_cg,
541 case SR_CONF_VOLTAGE_TARGET:
542 ch_spec = &(devc->device->channels[ch->index]);
543 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
544 /* Min, max, write resolution. */
545 for (i = 0; i < 3; i++) {
546 gvar = g_variant_new_double(ch_spec->voltage[i]);
547 g_variant_builder_add_value(&gvb, gvar);
549 *data = g_variant_builder_end(&gvb);
551 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
552 ch_spec = &(devc->device->channels[ch->index]);
553 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
554 /* Min, max, write resolution. */
555 for (i = 0; i < 3; i++) {
556 gvar = g_variant_new_double(ch_spec->frequency[i]);
557 g_variant_builder_add_value(&gvb, gvar);
559 *data = g_variant_builder_end(&gvb);
561 case SR_CONF_CURRENT_LIMIT:
562 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
563 /* Min, max, step. */
564 for (i = 0; i < 3; i++) {
565 ch_spec = &(devc->device->channels[ch->index]);
566 gvar = g_variant_new_double(ch_spec->current[i]);
567 g_variant_builder_add_value(&gvb, gvar);
569 *data = g_variant_builder_end(&gvb);
579 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
581 struct dev_context *devc;
582 struct sr_scpi_dev_inst *scpi;
583 struct sr_channel *ch;
584 struct pps_channel *pch;
587 if (sdi->status != SR_ST_ACTIVE)
588 return SR_ERR_DEV_CLOSED;
592 devc->cb_data = cb_data;
594 if ((ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
595 scpi_pps_receive_data, (void *)sdi)) != SR_OK)
597 std_session_send_df_header(sdi, LOG_PREFIX);
599 /* Prime the pipe with the first channel's fetch. */
600 ch = sr_next_enabled_channel(sdi, NULL);
602 if ((ret = select_channel(sdi, ch)) < 0)
604 if (pch->mq == SR_MQ_VOLTAGE)
605 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
606 else if (pch->mq == SR_MQ_FREQUENCY)
607 cmd = SCPI_CMD_GET_MEAS_FREQUENCY;
608 else if (pch->mq == SR_MQ_CURRENT)
609 cmd = SCPI_CMD_GET_MEAS_CURRENT;
610 else if (pch->mq == SR_MQ_POWER)
611 cmd = SCPI_CMD_GET_MEAS_POWER;
614 scpi_cmd(sdi, devc->device->commands, cmd, pch->hwname);
619 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
621 struct sr_datafeed_packet packet;
622 struct sr_scpi_dev_inst *scpi;
627 if (sdi->status != SR_ST_ACTIVE)
628 return SR_ERR_DEV_CLOSED;
633 * A requested value is certainly on the way. Retrieve it now,
634 * to avoid leaving the device in a state where it's not expecting
637 sr_scpi_get_float(scpi, NULL, &f);
638 sr_scpi_source_remove(sdi->session, scpi);
640 packet.type = SR_DF_END;
641 sr_session_send(sdi, &packet);
646 SR_PRIV struct sr_dev_driver scpi_pps_driver_info = {
648 .longname = "SCPI PPS",
653 .dev_list = dev_list,
654 .dev_clear = dev_clear,
655 .config_get = config_get,
656 .config_set = config_set,
657 .config_list = config_list,
658 .dev_open = dev_open,
659 .dev_close = dev_close,
660 .dev_acquisition_start = dev_acquisition_start,
661 .dev_acquisition_stop = dev_acquisition_stop,