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->status = SR_ST_INACTIVE;
95 sdi->vendor = g_strdup(vendor);
96 sdi->model = g_strdup(hw_info->model);
97 sdi->version = g_strdup(hw_info->firmware_version);
99 sdi->driver = &scpi_pps_driver_info;
100 sdi->inst_type = SR_INST_SCPI;
101 sdi->serial_num = g_strdup(hw_info->serial_number);
103 devc = g_malloc0(sizeof(struct dev_context));
104 devc->device = device;
107 if (device->num_channels) {
108 /* Static channels and groups. */
109 channels = (struct channel_spec *)device->channels;
110 num_channels = device->num_channels;
111 channel_groups = (struct channel_group_spec *)device->channel_groups;
112 num_channel_groups = device->num_channel_groups;
114 /* Channels and groups need to be probed. */
115 ret = device->probe_channels(sdi, hw_info, &channels, &num_channels,
116 &channel_groups, &num_channel_groups);
118 sr_err("Failed to probe for channels.");
122 * Since these were dynamically allocated, we'll need to free them
125 devc->channels = channels;
126 devc->channel_groups = channel_groups;
130 for (ch_num = 0; ch_num < num_channels; ch_num++) {
131 /* Create one channel per measurable output unit. */
132 for (i = 0; i < ARRAY_SIZE(pci); i++) {
133 if (!scpi_cmd_get(devc->device->commands, pci[i].command))
135 g_snprintf(ch_name, 16, "%s%s", pci[i].prefix,
136 channels[ch_num].name);
137 ch = sr_channel_new(sdi, ch_idx++, SR_CHANNEL_ANALOG, TRUE,
139 pch = g_malloc0(sizeof(struct pps_channel));
140 pch->hw_output_idx = ch_num;
141 pch->hwname = channels[ch_num].name;
147 for (i = 0; i < num_channel_groups; i++) {
148 cgs = &channel_groups[i];
149 cg = g_malloc0(sizeof(struct sr_channel_group));
150 cg->name = g_strdup(cgs->name);
151 for (j = 0, mask = 1; j < 64; j++, mask <<= 1) {
152 if (cgs->channel_index_mask & mask) {
153 for (l = sdi->channels; l; l = l->next) {
156 if (pch->hw_output_idx == j)
157 cg->channels = g_slist_append(cg->channels, ch);
161 pcg = g_malloc0(sizeof(struct pps_channel_group));
162 pcg->features = cgs->features;
164 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
167 sr_scpi_hw_info_free(hw_info);
170 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_LOCAL);
176 static GSList *scan(struct sr_dev_driver *di, GSList *options)
178 return sr_scpi_scan(di->context, options, probe_device);
181 static GSList *dev_list(const struct sr_dev_driver *di)
183 return ((struct drv_context *)(di->context))->instances;
186 static int dev_clear(const struct sr_dev_driver *di)
188 return std_dev_clear(di, NULL);
191 static int dev_open(struct sr_dev_inst *sdi)
193 struct dev_context *devc;
194 struct sr_scpi_dev_inst *scpi;
197 if (sdi->status != SR_ST_INACTIVE)
201 if (sr_scpi_open(scpi) < 0)
204 sdi->status = SR_ST_ACTIVE;
207 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_REMOTE);
209 devc->beeper_was_set = FALSE;
210 if (scpi_cmd_resp(sdi, devc->device->commands, &beeper,
211 G_VARIANT_TYPE_BOOLEAN, SCPI_CMD_BEEPER) == SR_OK) {
212 if (g_variant_get_boolean(beeper)) {
213 devc->beeper_was_set = TRUE;
214 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_BEEPER_DISABLE);
216 g_variant_unref(beeper);
222 static int dev_close(struct sr_dev_inst *sdi)
224 struct sr_scpi_dev_inst *scpi;
225 struct dev_context *devc;
227 if (sdi->status != SR_ST_ACTIVE)
228 return SR_ERR_DEV_CLOSED;
233 if (devc->beeper_was_set)
234 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_BEEPER_ENABLE);
235 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_LOCAL);
237 sdi->status = SR_ST_INACTIVE;
243 static void clear_helper(void *priv)
245 struct dev_context *devc;
248 g_free(devc->channels);
249 g_free(devc->channel_groups);
253 static int cleanup(const struct sr_dev_driver *di)
255 return std_dev_clear(di, clear_helper);
258 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
259 const struct sr_channel_group *cg)
261 struct dev_context *devc;
262 const GVariantType *gvtype;
274 * These options only apply to channel groups with a single
275 * channel -- they're per-channel settings for the device.
279 * Config keys are handled below depending on whether a channel
280 * group was provided by the frontend. However some of these
281 * take a CG on one PPS but not on others. Check the device's
282 * profile for that here, and NULL out the channel group as needed.
284 for (i = 0; i < devc->device->num_devopts; i++) {
285 if (devc->device->devopts[i] == key) {
295 case SR_CONF_ENABLED:
296 gvtype = G_VARIANT_TYPE_BOOLEAN;
297 cmd = SCPI_CMD_GET_OUTPUT_ENABLED;
299 case SR_CONF_VOLTAGE:
300 gvtype = G_VARIANT_TYPE_DOUBLE;
301 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
303 case SR_CONF_VOLTAGE_TARGET:
304 gvtype = G_VARIANT_TYPE_DOUBLE;
305 cmd = SCPI_CMD_GET_VOLTAGE_TARGET;
307 case SR_CONF_OUTPUT_FREQUENCY:
308 gvtype = G_VARIANT_TYPE_DOUBLE;
309 cmd = SCPI_CMD_GET_MEAS_FREQUENCY;
311 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
312 gvtype = G_VARIANT_TYPE_DOUBLE;
313 cmd = SCPI_CMD_GET_FREQUENCY_TARGET;
315 case SR_CONF_CURRENT:
316 gvtype = G_VARIANT_TYPE_DOUBLE;
317 cmd = SCPI_CMD_GET_MEAS_CURRENT;
319 case SR_CONF_CURRENT_LIMIT:
320 gvtype = G_VARIANT_TYPE_DOUBLE;
321 cmd = SCPI_CMD_GET_CURRENT_LIMIT;
323 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
324 gvtype = G_VARIANT_TYPE_BOOLEAN;
325 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED;
327 case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
328 gvtype = G_VARIANT_TYPE_BOOLEAN;
329 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE;
331 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
332 gvtype = G_VARIANT_TYPE_DOUBLE;
333 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD;
335 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
336 gvtype = G_VARIANT_TYPE_BOOLEAN;
337 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED;
339 case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
340 gvtype = G_VARIANT_TYPE_BOOLEAN;
341 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE;
343 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
344 gvtype = G_VARIANT_TYPE_DOUBLE;
345 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD;
347 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
348 gvtype = G_VARIANT_TYPE_BOOLEAN;
349 cmd = SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION;
351 case SR_CONF_REGULATION:
352 gvtype = G_VARIANT_TYPE_STRING;
353 cmd = SCPI_CMD_GET_OUTPUT_REGULATION;
359 select_channel(sdi, cg->channels->data);
360 ret = scpi_cmd_resp(sdi, devc->device->commands, data, gvtype, cmd);
362 if (cmd == SCPI_CMD_GET_OUTPUT_REGULATION) {
364 * The Rigol DP800 series return CV/CC/UR, Philips PM2800
365 * return VOLT/CURR. We always return a GVariant string in
366 * the Rigol notation.
368 s = g_variant_get_string(*data, NULL);
369 if (!strcmp(s, "VOLT")) {
370 g_variant_unref(*data);
371 *data = g_variant_new_string("CV");
372 } else if (!strcmp(s, "CURR")) {
373 g_variant_unref(*data);
374 *data = g_variant_new_string("CC");
377 s = g_variant_get_string(*data, NULL);
378 if (strcmp(s, "CV") && strcmp(s, "CC") && strcmp(s, "UR")) {
379 sr_dbg("Unknown response to SCPI_CMD_GET_OUTPUT_REGULATION: %s", s);
387 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
388 const struct sr_channel_group *cg)
390 struct dev_context *devc;
397 if (sdi->status != SR_ST_ACTIVE)
398 return SR_ERR_DEV_CLOSED;
401 /* Channel group specified. */
402 select_channel(sdi, cg->channels->data);
407 case SR_CONF_ENABLED:
408 if (g_variant_get_boolean(data))
409 ret = scpi_cmd(sdi, devc->device->commands,
410 SCPI_CMD_SET_OUTPUT_ENABLE);
412 ret = scpi_cmd(sdi, devc->device->commands,
413 SCPI_CMD_SET_OUTPUT_DISABLE);
415 case SR_CONF_VOLTAGE_TARGET:
416 d = g_variant_get_double(data);
417 ret = scpi_cmd(sdi, devc->device->commands,
418 SCPI_CMD_SET_VOLTAGE_TARGET, d);
420 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
421 d = g_variant_get_double(data);
422 ret = scpi_cmd(sdi, devc->device->commands,
423 SCPI_CMD_SET_FREQUENCY_TARGET, d);
425 case SR_CONF_CURRENT_LIMIT:
426 d = g_variant_get_double(data);
427 ret = scpi_cmd(sdi, devc->device->commands,
428 SCPI_CMD_SET_CURRENT_LIMIT, d);
430 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
431 if (g_variant_get_boolean(data))
432 ret = scpi_cmd(sdi, devc->device->commands,
433 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLE);
435 ret = scpi_cmd(sdi, devc->device->commands,
436 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_DISABLE);
438 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
439 d = g_variant_get_double(data);
440 ret = scpi_cmd(sdi, devc->device->commands,
441 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD, d);
443 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
444 if (g_variant_get_boolean(data))
445 ret = scpi_cmd(sdi, devc->device->commands,
446 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLE);
448 ret = scpi_cmd(sdi, devc->device->commands,
449 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_DISABLE);
451 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
452 d = g_variant_get_double(data);
453 ret = scpi_cmd(sdi, devc->device->commands,
454 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD, d);
456 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
457 if (g_variant_get_boolean(data))
458 ret = scpi_cmd(sdi, devc->device->commands,
459 SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_ENABLE);
461 ret = scpi_cmd(sdi, devc->device->commands,
462 SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_DISABLE);
471 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
472 const struct sr_channel_group *cg)
474 struct dev_context *devc;
475 struct sr_channel *ch;
476 const struct channel_spec *ch_spec;
482 /* Always available, even without sdi. */
483 if (key == SR_CONF_SCAN_OPTIONS) {
484 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
485 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
487 } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
488 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
489 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
499 /* No channel group: global options. */
501 case SR_CONF_DEVICE_OPTIONS:
502 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
503 devc->device->devopts, devc->device->num_devopts,
506 case SR_CONF_CHANNEL_CONFIG:
509 if (devc->device->features & PPS_INDEPENDENT)
510 s[i++] = "Independent";
511 if (devc->device->features & PPS_SERIES)
513 if (devc->device->features & PPS_PARALLEL)
517 * Shouldn't happen: independent-only devices
518 * shouldn't advertise this option at all.
522 *data = g_variant_new_strv(s, i);
528 /* Channel group specified. */
530 * Per-channel-group options depending on a channel are actually
531 * done with the first channel. Channel groups in PPS can have
532 * more than one channel, but they will typically be of equal
533 * specification for use in series or parallel mode.
535 ch = cg->channels->data;
538 case SR_CONF_DEVICE_OPTIONS:
539 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
540 devc->device->devopts_cg, devc->device->num_devopts_cg,
543 case SR_CONF_VOLTAGE_TARGET:
544 ch_spec = &(devc->device->channels[ch->index]);
545 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
546 /* Min, max, write resolution. */
547 for (i = 0; i < 3; i++) {
548 gvar = g_variant_new_double(ch_spec->voltage[i]);
549 g_variant_builder_add_value(&gvb, gvar);
551 *data = g_variant_builder_end(&gvb);
553 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
554 ch_spec = &(devc->device->channels[ch->index]);
555 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
556 /* Min, max, write resolution. */
557 for (i = 0; i < 3; i++) {
558 gvar = g_variant_new_double(ch_spec->frequency[i]);
559 g_variant_builder_add_value(&gvb, gvar);
561 *data = g_variant_builder_end(&gvb);
563 case SR_CONF_CURRENT_LIMIT:
564 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
565 /* Min, max, step. */
566 for (i = 0; i < 3; i++) {
567 ch_spec = &(devc->device->channels[ch->index]);
568 gvar = g_variant_new_double(ch_spec->current[i]);
569 g_variant_builder_add_value(&gvb, gvar);
571 *data = g_variant_builder_end(&gvb);
581 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
583 struct dev_context *devc;
584 struct sr_scpi_dev_inst *scpi;
585 struct sr_channel *ch;
586 struct pps_channel *pch;
589 if (sdi->status != SR_ST_ACTIVE)
590 return SR_ERR_DEV_CLOSED;
594 devc->cb_data = cb_data;
596 if ((ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
597 scpi_pps_receive_data, (void *)sdi)) != SR_OK)
599 std_session_send_df_header(sdi, LOG_PREFIX);
601 /* Prime the pipe with the first channel's fetch. */
602 ch = sr_next_enabled_channel(sdi, NULL);
604 if ((ret = select_channel(sdi, ch)) < 0)
606 if (pch->mq == SR_MQ_VOLTAGE)
607 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
608 else if (pch->mq == SR_MQ_FREQUENCY)
609 cmd = SCPI_CMD_GET_MEAS_FREQUENCY;
610 else if (pch->mq == SR_MQ_CURRENT)
611 cmd = SCPI_CMD_GET_MEAS_CURRENT;
612 else if (pch->mq == SR_MQ_POWER)
613 cmd = SCPI_CMD_GET_MEAS_POWER;
616 scpi_cmd(sdi, devc->device->commands, cmd, pch->hwname);
621 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
623 struct sr_datafeed_packet packet;
624 struct sr_scpi_dev_inst *scpi;
629 if (sdi->status != SR_ST_ACTIVE)
630 return SR_ERR_DEV_CLOSED;
635 * A requested value is certainly on the way. Retrieve it now,
636 * to avoid leaving the device in a state where it's not expecting
639 sr_scpi_get_float(scpi, NULL, &f);
640 sr_scpi_source_remove(sdi->session, scpi);
642 packet.type = SR_DF_END;
643 sr_session_send(sdi, &packet);
648 SR_PRIV struct sr_dev_driver scpi_pps_driver_info = {
650 .longname = "SCPI PPS",
655 .dev_list = dev_list,
656 .dev_clear = dev_clear,
657 .config_get = config_get,
658 .config_set = config_set,
659 .config_list = config_list,
660 .dev_open = dev_open,
661 .dev_close = dev_close,
662 .dev_acquisition_start = dev_acquisition_start,
663 .dev_acquisition_stop = dev_acquisition_stop,