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 struct channel_spec *channels;
54 struct channel_group_spec *channel_groups, *cgs;
55 struct pps_channel_group *pcg;
60 unsigned int num_channels, num_channel_groups, ch_num, ch_idx, i, j;
65 if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
66 sr_info("Couldn't get IDN response.");
71 for (i = 0; i < num_pps_profiles; i++) {
72 vendor = get_vendor(hw_info->manufacturer);
73 if (strcasecmp(vendor, pps_profiles[i].vendor))
75 model_re = g_regex_new(pps_profiles[i].model, 0, 0, NULL);
76 if (g_regex_match(model_re, hw_info->model, 0, &model_mi))
77 device = &pps_profiles[i];
78 g_match_info_unref(model_mi);
79 g_regex_unref(model_re);
84 sr_scpi_hw_info_free(hw_info);
88 sdi = sr_dev_inst_new(SR_ST_ACTIVE, vendor, hw_info->model,
89 hw_info->firmware_version);
92 sdi->inst_type = SR_INST_SCPI;
93 sdi->serial_num = g_strdup(hw_info->serial_number);
95 devc = g_malloc0(sizeof(struct dev_context));
96 devc->device = device;
99 if (device->num_channels) {
100 /* Static channels and groups. */
101 channels = device->channels;
102 num_channels = device->num_channels;
103 channel_groups = device->channel_groups;
104 num_channel_groups = device->num_channel_groups;
106 /* Channels and groups need to be probed. */
107 ret = device->probe_channels(sdi, hw_info, &channels, &num_channels,
108 &channel_groups, &num_channel_groups);
110 sr_err("Failed to probe for channels.");
114 * Since these were dynamically allocated, we'll need to free them
117 devc->channels = channels;
118 devc->channel_groups = channel_groups;
122 for (ch_num = 0; ch_num < num_channels; ch_num++) {
123 /* Create one channel per measurable output unit. */
124 for (i = 0; i < ARRAY_SIZE(pci); i++) {
125 if (!scpi_cmd_get(sdi, pci[i].command))
127 g_snprintf(ch_name, 16, "%s%s", pci[i].prefix,
128 channels[ch_num].name);
129 ch = sr_channel_new(ch_idx++, SR_CHANNEL_ANALOG, TRUE, ch_name);
130 pch = g_malloc0(sizeof(struct pps_channel));
131 pch->hw_output_idx = ch_num;
132 pch->hwname = channels[ch_num].name;
135 sdi->channels = g_slist_append(sdi->channels, ch);
139 for (i = 0; i < num_channel_groups; i++) {
140 cgs = &channel_groups[i];
141 cg = g_malloc0(sizeof(struct sr_channel_group));
142 cg->name = g_strdup(cgs->name);
143 for (j = 0, mask = 1; j < 64; j++, mask <<= 1) {
144 if (cgs->channel_index_mask & mask) {
145 for (l = sdi->channels; l; l = l->next) {
148 if (pch->hw_output_idx == j)
149 cg->channels = g_slist_append(cg->channels, ch);
153 pcg = g_malloc0(sizeof(struct pps_channel_group));
154 pcg->features = cgs->features;
156 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
159 sr_scpi_hw_info_free(hw_info);
162 scpi_cmd(sdi, SCPI_CMD_LOCAL);
168 static GSList *scan(GSList *options)
170 return sr_scpi_scan(di->priv, options, probe_device);
173 static GSList *dev_list(void)
175 return ((struct drv_context *)(di->priv))->instances;
178 static int dev_clear(void)
180 return std_dev_clear(di, NULL);
183 static int dev_open(struct sr_dev_inst *sdi)
185 struct dev_context *devc;
186 struct sr_scpi_dev_inst *scpi;
189 if (sdi->status != SR_ST_ACTIVE)
193 if (sr_scpi_open(scpi) < 0)
196 sdi->status = SR_ST_ACTIVE;
198 scpi_cmd(sdi, SCPI_CMD_REMOTE);
200 devc->beeper_was_set = FALSE;
201 if (scpi_cmd_resp(sdi, &beeper, G_VARIANT_TYPE_BOOLEAN, SCPI_CMD_BEEPER) == SR_OK) {
202 if (g_variant_get_boolean(beeper)) {
203 devc->beeper_was_set = TRUE;
204 scpi_cmd(sdi, SCPI_CMD_BEEPER_DISABLE);
206 g_variant_unref(beeper);
212 static int dev_close(struct sr_dev_inst *sdi)
214 struct sr_scpi_dev_inst *scpi;
215 struct dev_context *devc;
217 if (sdi->status != SR_ST_ACTIVE)
218 return SR_ERR_DEV_CLOSED;
223 if (devc->beeper_was_set)
224 scpi_cmd(sdi, SCPI_CMD_BEEPER_ENABLE);
225 scpi_cmd(sdi, SCPI_CMD_LOCAL);
227 sdi->status = SR_ST_INACTIVE;
233 static void clear_helper(void *priv)
235 struct dev_context *devc;
238 g_free(devc->channels);
239 g_free(devc->channel_groups);
243 static int cleanup(void)
245 return std_dev_clear(di, clear_helper);
248 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
249 const struct sr_channel_group *cg)
251 struct dev_context *devc;
252 const GVariantType *gvtype;
264 * These options only apply to channel groups with a single
265 * channel -- they're per-channel settings for the device.
269 * Config keys are handled below depending on whether a channel
270 * group was provided by the frontend. However some of these
271 * take a CG on one PPS but not on others. Check the device's
272 * profile for that here, and NULL out the channel group as needed.
274 for (i = 0; i < devc->device->num_devopts; i++) {
275 if (devc->device->devopts[i] == key) {
285 case SR_CONF_OUTPUT_ENABLED:
286 gvtype = G_VARIANT_TYPE_BOOLEAN;
287 cmd = SCPI_CMD_GET_OUTPUT_ENABLED;
289 case SR_CONF_OUTPUT_VOLTAGE:
290 gvtype = G_VARIANT_TYPE_DOUBLE;
291 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
293 case SR_CONF_OUTPUT_VOLTAGE_TARGET:
294 gvtype = G_VARIANT_TYPE_DOUBLE;
295 cmd = SCPI_CMD_GET_VOLTAGE_TARGET;
297 case SR_CONF_OUTPUT_CURRENT:
298 gvtype = G_VARIANT_TYPE_DOUBLE;
299 cmd = SCPI_CMD_GET_MEAS_CURRENT;
301 case SR_CONF_OUTPUT_CURRENT_LIMIT:
302 gvtype = G_VARIANT_TYPE_DOUBLE;
303 cmd = SCPI_CMD_GET_CURRENT_LIMIT;
305 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
306 gvtype = G_VARIANT_TYPE_BOOLEAN;
307 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED;
309 case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
310 gvtype = G_VARIANT_TYPE_BOOLEAN;
311 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE;
313 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
314 gvtype = G_VARIANT_TYPE_DOUBLE;
315 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD;
317 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
318 gvtype = G_VARIANT_TYPE_BOOLEAN;
319 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED;
321 case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
322 gvtype = G_VARIANT_TYPE_BOOLEAN;
323 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE;
325 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
326 gvtype = G_VARIANT_TYPE_DOUBLE;
327 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD;
329 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
330 gvtype = G_VARIANT_TYPE_BOOLEAN;
331 cmd = SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION;
333 case SR_CONF_OUTPUT_REGULATION:
334 gvtype = G_VARIANT_TYPE_STRING;
335 cmd = SCPI_CMD_GET_OUTPUT_REGULATION;
339 select_channel(sdi, cg->channels->data);
340 ret = scpi_cmd_resp(sdi, data, gvtype, cmd);
342 if (gvtype == G_VARIANT_TYPE_STRING && ret == SR_OK) {
343 /* Non-standard data type responses. */
345 case SCPI_CMD_GET_OUTPUT_REGULATION:
347 * This is specific to the Rigol DP800 series.
348 * We return the same string for now until more
349 * models with this key are supported. Do a check
350 * just for the hell of it.
352 s = g_variant_get_string(*data, NULL);
353 if (strcmp(s, "CC") && strcmp(s, "CV") && strcmp(s, "UR")) {
354 sr_dbg("Unknown response to SCPI_CMD_GET_OUTPUT_REGULATION: %s", s);
366 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
367 const struct sr_channel_group *cg)
375 if (sdi->status != SR_ST_ACTIVE)
376 return SR_ERR_DEV_CLOSED;
379 /* Channel group specified. */
380 select_channel(sdi, cg->channels->data);
384 case SR_CONF_OUTPUT_ENABLED:
385 if (g_variant_get_boolean(data))
386 ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_ENABLE);
388 ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_DISABLE);
390 case SR_CONF_OUTPUT_VOLTAGE_TARGET:
391 d = g_variant_get_double(data);
392 ret = scpi_cmd(sdi, SCPI_CMD_SET_VOLTAGE_TARGET, d);
394 case SR_CONF_OUTPUT_CURRENT_LIMIT:
395 d = g_variant_get_double(data);
396 ret = scpi_cmd(sdi, SCPI_CMD_SET_CURRENT_LIMIT, d);
398 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
399 if (g_variant_get_boolean(data))
400 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLE);
402 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_DISABLE);
404 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
405 d = g_variant_get_double(data);
406 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD, d);
408 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
409 if (g_variant_get_boolean(data))
410 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLE);
412 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_DISABLE);
414 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
415 d = g_variant_get_double(data);
416 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD, d);
418 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
419 if (g_variant_get_boolean(data))
420 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_ENABLE);
422 ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_DISABLE);
431 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
432 const struct sr_channel_group *cg)
434 struct dev_context *devc;
435 struct sr_channel *ch;
436 struct channel_spec *ch_spec;
442 /* Always available, even without sdi. */
443 if (key == SR_CONF_SCAN_OPTIONS) {
444 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
445 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
455 /* No channel group: global options. */
457 case SR_CONF_DEVICE_OPTIONS:
458 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
459 devc->device->devopts, devc->device->num_devopts,
462 case SR_CONF_OUTPUT_CHANNEL_CONFIG:
465 if (devc->device->features & PPS_INDEPENDENT)
466 s[i++] = "Independent";
467 if (devc->device->features & PPS_SERIES)
469 if (devc->device->features & PPS_PARALLEL)
473 * Shouldn't happen: independent-only devices
474 * shouldn't advertise this option at all.
478 *data = g_variant_new_strv(s, i);
484 /* Channel group specified. */
486 * Per-channel-group options depending on a channel are actually
487 * done with the first channel. Channel groups in PPS can have
488 * more than one channel, but they will typically be of equal
489 * specification for use in series or parallel mode.
491 ch = cg->channels->data;
494 case SR_CONF_DEVICE_OPTIONS:
495 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
496 devc->device->devopts_cg, devc->device->num_devopts_cg,
499 case SR_CONF_OUTPUT_VOLTAGE_TARGET:
500 ch_spec = &(devc->device->channels[ch->index]);
501 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
502 /* Min, max, write resolution. */
503 for (i = 0; i < 3; i++) {
504 gvar = g_variant_new_double(ch_spec->voltage[i]);
505 g_variant_builder_add_value(&gvb, gvar);
507 *data = g_variant_builder_end(&gvb);
509 case SR_CONF_OUTPUT_CURRENT_LIMIT:
510 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
511 /* Min, max, step. */
512 for (i = 0; i < 3; i++) {
513 ch_spec = &(devc->device->channels[ch->index]);
514 gvar = g_variant_new_double(ch_spec->current[i]);
515 g_variant_builder_add_value(&gvb, gvar);
517 *data = g_variant_builder_end(&gvb);
527 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
530 struct dev_context *devc;
531 struct sr_scpi_dev_inst *scpi;
532 struct sr_channel *ch;
533 struct pps_channel *pch;
536 if (sdi->status != SR_ST_ACTIVE)
537 return SR_ERR_DEV_CLOSED;
541 devc->cb_data = cb_data;
543 if ((ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
544 scpi_pps_receive_data, (void *)sdi)) != SR_OK)
546 std_session_send_df_header(sdi, LOG_PREFIX);
548 /* Prime the pipe with the first channel's fetch. */
549 ch = next_enabled_channel(sdi, NULL);
551 if ((ret = select_channel(sdi, ch)) != SR_OK)
553 if (pch->mq == SR_MQ_VOLTAGE)
554 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
555 else if (pch->mq == SR_MQ_CURRENT)
556 cmd = SCPI_CMD_GET_MEAS_CURRENT;
557 else if (pch->mq == SR_MQ_POWER)
558 cmd = SCPI_CMD_GET_MEAS_POWER;
561 scpi_cmd(sdi, cmd, pch->hwname);
566 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
568 struct sr_datafeed_packet packet;
569 struct sr_scpi_dev_inst *scpi;
574 if (sdi->status != SR_ST_ACTIVE)
575 return SR_ERR_DEV_CLOSED;
580 * A requested value is certainly on the way. Retrieve it now,
581 * to avoid leaving the device in a state where it's not expecting
584 sr_scpi_get_float(scpi, NULL, &f);
585 sr_scpi_source_remove(sdi->session, scpi);
587 packet.type = SR_DF_END;
588 sr_session_send(sdi, &packet);
593 SR_PRIV struct sr_dev_driver scpi_pps_driver_info = {
595 .longname = "SCPI PPS",
600 .dev_list = dev_list,
601 .dev_clear = dev_clear,
602 .config_get = config_get,
603 .config_set = config_set,
604 .config_list = config_list,
605 .dev_open = dev_open,
606 .dev_close = dev_close,
607 .dev_acquisition_start = dev_acquisition_start,
608 .dev_acquisition_stop = dev_acquisition_stop,