2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2017 Frank Stettner <frank-stettner@gmx.net>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
27 static struct sr_dev_driver scpi_pps_driver_info;
28 static struct sr_dev_driver hp_ib_pps_driver_info;
30 static const uint32_t scanopts[] = {
35 static const uint32_t drvopts[] = {
39 static const struct pps_channel_instance pci[] = {
40 { SR_MQ_VOLTAGE, SCPI_CMD_GET_MEAS_VOLTAGE, "V" },
41 { SR_MQ_CURRENT, SCPI_CMD_GET_MEAS_CURRENT, "I" },
42 { SR_MQ_POWER, SCPI_CMD_GET_MEAS_POWER, "P" },
43 { SR_MQ_FREQUENCY, SCPI_CMD_GET_MEAS_FREQUENCY, "F" },
46 static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi,
47 int (*get_hw_id)(struct sr_scpi_dev_inst *scpi,
48 struct sr_scpi_hw_info **scpi_response))
50 struct dev_context *devc;
51 struct sr_dev_inst *sdi;
52 struct sr_scpi_hw_info *hw_info;
53 struct sr_channel_group *cg;
54 struct sr_channel *ch;
55 const struct scpi_pps *device;
56 struct pps_channel *pch;
57 struct channel_spec *channels;
58 struct channel_group_spec *channel_groups, *cgs;
59 struct pps_channel_group *pcg;
64 unsigned int num_channels, num_channel_groups, ch_num, ch_idx, i, j;
69 if (get_hw_id(scpi, &hw_info) != SR_OK) {
70 sr_info("Couldn't get IDN response.");
75 for (i = 0; i < num_pps_profiles; i++) {
76 vendor = sr_vendor_alias(hw_info->manufacturer);
77 if (g_ascii_strcasecmp(vendor, pps_profiles[i].vendor))
79 model_re = g_regex_new(pps_profiles[i].model, 0, 0, NULL);
80 if (g_regex_match(model_re, hw_info->model, 0, &model_mi))
81 device = &pps_profiles[i];
82 g_match_info_unref(model_mi);
83 g_regex_unref(model_re);
88 sr_scpi_hw_info_free(hw_info);
92 sdi = g_malloc0(sizeof(struct sr_dev_inst));
93 sdi->vendor = g_strdup(vendor);
94 sdi->model = g_strdup(hw_info->model);
95 sdi->version = g_strdup(hw_info->firmware_version);
97 sdi->driver = &scpi_pps_driver_info;
98 sdi->inst_type = SR_INST_SCPI;
99 sdi->serial_num = g_strdup(hw_info->serial_number);
101 devc = g_malloc0(sizeof(struct dev_context));
102 devc->device = device;
103 sr_sw_limits_init(&devc->limits);
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 (!sr_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 sr_scpi_cmd(sdi, devc->device->commands, 0, NULL, SCPI_CMD_LOCAL);
174 static gchar *hpib_get_revision(struct sr_scpi_dev_inst *scpi)
179 GRegex *version_regex;
181 ret = sr_scpi_get_string(scpi, "ROM?", &response);
182 if (ret != SR_OK && !response)
185 /* Example version string: "B01 B01" */
186 version_regex = g_regex_new("[A-Z][0-9]{2} [A-Z][0-9]{2}", 0, 0, NULL);
187 matches = g_regex_match(version_regex, response, 0, NULL);
188 g_regex_unref(version_regex);
191 /* Not a valid version string. Ignore it. */
195 /* Replace space with dot. */
203 * This function assumes the response is in the form "HP<model_number>"
205 * HP made many GPIB (then called HP-IB) instruments before the SCPI command
206 * set was introduced into the standard. We haven't seen any non-HP instruments
207 * which respond to the "ID?" query, so assume all are HP for now.
209 static int hpib_get_hw_id(struct sr_scpi_dev_inst *scpi,
210 struct sr_scpi_hw_info **scpi_response)
214 struct sr_scpi_hw_info *hw_info;
216 ret = sr_scpi_get_string(scpi, "ID?", &response);
217 if ((ret != SR_OK) || !response)
220 hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info));
222 *scpi_response = hw_info;
223 hw_info->model = response;
224 hw_info->firmware_version = hpib_get_revision(scpi);
225 hw_info->manufacturer = g_strdup("HP");
230 static struct sr_dev_inst *probe_scpi_pps_device(struct sr_scpi_dev_inst *scpi)
232 return probe_device(scpi, sr_scpi_get_hw_id);
235 static struct sr_dev_inst *probe_hpib_pps_device(struct sr_scpi_dev_inst *scpi)
237 return probe_device(scpi, hpib_get_hw_id);
240 static GSList *scan_scpi_pps(struct sr_dev_driver *di, GSList *options)
242 return sr_scpi_scan(di->context, options, probe_scpi_pps_device);
245 static GSList *scan_hpib_pps(struct sr_dev_driver *di, GSList *options)
247 return sr_scpi_scan(di->context, options, probe_hpib_pps_device);
250 static int dev_open(struct sr_dev_inst *sdi)
252 struct dev_context *devc;
253 struct sr_scpi_dev_inst *scpi;
257 if (sr_scpi_open(scpi) < 0)
261 sr_scpi_cmd(sdi, devc->device->commands, 0, NULL, SCPI_CMD_REMOTE);
262 devc->beeper_was_set = FALSE;
263 if (sr_scpi_cmd_resp(sdi, devc->device->commands, 0, NULL,
264 &beeper, G_VARIANT_TYPE_BOOLEAN, SCPI_CMD_BEEPER) == SR_OK) {
265 if (g_variant_get_boolean(beeper)) {
266 devc->beeper_was_set = TRUE;
267 sr_scpi_cmd(sdi, devc->device->commands,
268 0, NULL, SCPI_CMD_BEEPER_DISABLE);
270 g_variant_unref(beeper);
276 static int dev_close(struct sr_dev_inst *sdi)
278 struct sr_scpi_dev_inst *scpi;
279 struct dev_context *devc;
287 if (devc->beeper_was_set)
288 sr_scpi_cmd(sdi, devc->device->commands,
289 0, NULL, SCPI_CMD_BEEPER_ENABLE);
290 sr_scpi_cmd(sdi, devc->device->commands, 0, NULL, SCPI_CMD_LOCAL);
292 return sr_scpi_close(scpi);
295 static void clear_helper(struct dev_context *devc)
297 g_free(devc->channels);
298 g_free(devc->channel_groups);
301 static int dev_clear(const struct sr_dev_driver *di)
303 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
306 static int config_get(uint32_t key, GVariant **data,
307 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
309 struct dev_context *devc;
310 const GVariantType *gvtype;
312 int channel_group_cmd;
313 char *channel_group_name;
324 * These options only apply to channel groups with a single
325 * channel -- they're per-channel settings for the device.
329 * Config keys are handled below depending on whether a channel
330 * group was provided by the frontend. However some of these
331 * take a CG on one PPS but not on others. Check the device's
332 * profile for that here, and NULL out the channel group as needed.
334 for (i = 0; i < devc->device->num_devopts; i++) {
335 if (devc->device->devopts[i] == key) {
345 case SR_CONF_ENABLED:
346 gvtype = G_VARIANT_TYPE_BOOLEAN;
347 cmd = SCPI_CMD_GET_OUTPUT_ENABLED;
349 case SR_CONF_VOLTAGE:
350 gvtype = G_VARIANT_TYPE_DOUBLE;
351 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
353 case SR_CONF_VOLTAGE_TARGET:
354 gvtype = G_VARIANT_TYPE_DOUBLE;
355 cmd = SCPI_CMD_GET_VOLTAGE_TARGET;
357 case SR_CONF_OUTPUT_FREQUENCY:
358 gvtype = G_VARIANT_TYPE_DOUBLE;
359 cmd = SCPI_CMD_GET_MEAS_FREQUENCY;
361 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
362 gvtype = G_VARIANT_TYPE_DOUBLE;
363 cmd = SCPI_CMD_GET_FREQUENCY_TARGET;
365 case SR_CONF_CURRENT:
366 gvtype = G_VARIANT_TYPE_DOUBLE;
367 cmd = SCPI_CMD_GET_MEAS_CURRENT;
369 case SR_CONF_CURRENT_LIMIT:
370 gvtype = G_VARIANT_TYPE_DOUBLE;
371 cmd = SCPI_CMD_GET_CURRENT_LIMIT;
373 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
374 gvtype = G_VARIANT_TYPE_BOOLEAN;
375 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED;
377 case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
378 gvtype = G_VARIANT_TYPE_BOOLEAN;
379 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE;
381 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
382 gvtype = G_VARIANT_TYPE_DOUBLE;
383 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD;
385 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
386 gvtype = G_VARIANT_TYPE_BOOLEAN;
387 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED;
389 case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
390 gvtype = G_VARIANT_TYPE_BOOLEAN;
391 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE;
393 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
394 gvtype = G_VARIANT_TYPE_DOUBLE;
395 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD;
397 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
398 gvtype = G_VARIANT_TYPE_BOOLEAN;
399 cmd = SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION;
401 case SR_CONF_REGULATION:
402 gvtype = G_VARIANT_TYPE_STRING;
403 cmd = SCPI_CMD_GET_OUTPUT_REGULATION;
406 return sr_sw_limits_config_get(&devc->limits, key, data);
411 channel_group_cmd = 0;
412 channel_group_name = NULL;
414 channel_group_cmd = SCPI_CMD_SELECT_CHANNEL;
415 channel_group_name = g_strdup(cg->name);
418 ret = sr_scpi_cmd_resp(sdi, devc->device->commands,
419 channel_group_cmd, channel_group_name, data, gvtype, cmd);
420 g_free(channel_group_name);
422 if (cmd == SCPI_CMD_GET_OUTPUT_REGULATION) {
424 * The Rigol DP800 series return CV/CC/UR, Philips PM2800
425 * return VOLT/CURR. We always return a GVariant string in
426 * the Rigol notation.
428 s = g_variant_get_string(*data, NULL);
429 if (!strcmp(s, "VOLT")) {
430 g_variant_unref(*data);
431 *data = g_variant_new_string("CV");
432 } else if (!strcmp(s, "CURR")) {
433 g_variant_unref(*data);
434 *data = g_variant_new_string("CC");
437 s = g_variant_get_string(*data, NULL);
438 if (strcmp(s, "CV") && strcmp(s, "CC") && strcmp(s, "UR")) {
439 sr_dbg("Unknown response to SCPI_CMD_GET_OUTPUT_REGULATION: %s", s);
447 static int config_set(uint32_t key, GVariant *data,
448 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
450 struct dev_context *devc;
452 int channel_group_cmd;
453 char *channel_group_name;
459 channel_group_cmd = 0;
460 channel_group_name = NULL;
462 channel_group_cmd = SCPI_CMD_SELECT_CHANNEL;
463 channel_group_name = g_strdup(cg->name);
469 case SR_CONF_ENABLED:
470 if (g_variant_get_boolean(data))
471 ret = sr_scpi_cmd(sdi, devc->device->commands,
472 channel_group_cmd, channel_group_name,
473 SCPI_CMD_SET_OUTPUT_ENABLE);
475 ret = sr_scpi_cmd(sdi, devc->device->commands,
476 channel_group_cmd, channel_group_name,
477 SCPI_CMD_SET_OUTPUT_DISABLE);
479 case SR_CONF_VOLTAGE_TARGET:
480 d = g_variant_get_double(data);
481 ret = sr_scpi_cmd(sdi, devc->device->commands,
482 channel_group_cmd, channel_group_name,
483 SCPI_CMD_SET_VOLTAGE_TARGET, d);
485 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
486 d = g_variant_get_double(data);
487 ret = sr_scpi_cmd(sdi, devc->device->commands,
488 channel_group_cmd, channel_group_name,
489 SCPI_CMD_SET_FREQUENCY_TARGET, d);
491 case SR_CONF_CURRENT_LIMIT:
492 d = g_variant_get_double(data);
493 ret = sr_scpi_cmd(sdi, devc->device->commands,
494 channel_group_cmd, channel_group_name,
495 SCPI_CMD_SET_CURRENT_LIMIT, d);
497 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
498 if (g_variant_get_boolean(data))
499 ret = sr_scpi_cmd(sdi, devc->device->commands,
500 channel_group_cmd, channel_group_name,
501 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLE);
503 ret = sr_scpi_cmd(sdi, devc->device->commands,
504 channel_group_cmd, channel_group_name,
505 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_DISABLE);
507 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
508 d = g_variant_get_double(data);
509 ret = sr_scpi_cmd(sdi, devc->device->commands,
510 channel_group_cmd, channel_group_name,
511 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD, d);
513 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
514 if (g_variant_get_boolean(data))
515 ret = sr_scpi_cmd(sdi, devc->device->commands,
516 channel_group_cmd, channel_group_name,
517 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLE);
519 ret = sr_scpi_cmd(sdi, devc->device->commands,
520 channel_group_cmd, channel_group_name,
521 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_DISABLE);
523 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
524 d = g_variant_get_double(data);
525 ret = sr_scpi_cmd(sdi, devc->device->commands,
526 channel_group_cmd, channel_group_name,
527 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD, d);
529 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
530 if (g_variant_get_boolean(data))
531 ret = sr_scpi_cmd(sdi, devc->device->commands,
532 channel_group_cmd, channel_group_name,
533 SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_ENABLE);
535 ret = sr_scpi_cmd(sdi, devc->device->commands,
536 channel_group_cmd, channel_group_name,
537 SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_DISABLE);
540 ret = sr_sw_limits_config_set(&devc->limits, key, data);
543 g_free(channel_group_name);
548 static int config_list(uint32_t key, GVariant **data,
549 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
551 struct dev_context *devc;
552 struct sr_channel *ch;
553 const struct channel_spec *ch_spec;
557 devc = (sdi) ? sdi->priv : NULL;
561 case SR_CONF_SCAN_OPTIONS:
562 case SR_CONF_DEVICE_OPTIONS:
563 return std_opts_config_list(key, data, sdi, cg,
564 ARRAY_AND_SIZE(scanopts),
565 ARRAY_AND_SIZE(drvopts),
566 (devc && devc->device) ? devc->device->devopts : NULL,
567 (devc && devc->device) ? devc->device->num_devopts : 0);
569 case SR_CONF_CHANNEL_CONFIG:
570 if (!devc || !devc->device)
574 if (devc->device->features & PPS_INDEPENDENT)
575 s[i++] = "Independent";
576 if (devc->device->features & PPS_SERIES)
578 if (devc->device->features & PPS_PARALLEL)
582 * Shouldn't happen: independent-only devices
583 * shouldn't advertise this option at all.
587 *data = g_variant_new_strv(s, i);
594 * Per-channel-group options depending on a channel are actually
595 * done with the first channel. Channel groups in PPS can have
596 * more than one channel, but they will typically be of equal
597 * specification for use in series or parallel mode.
599 ch = cg->channels->data;
600 if (!devc || !devc->device)
602 ch_spec = &(devc->device->channels[ch->index]);
605 case SR_CONF_DEVICE_OPTIONS:
606 *data = std_gvar_array_u32(devc->device->devopts_cg, devc->device->num_devopts_cg);
608 case SR_CONF_VOLTAGE_TARGET:
609 *data = std_gvar_min_max_step_array(ch_spec->voltage);
611 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
612 *data = std_gvar_min_max_step_array(ch_spec->frequency);
614 case SR_CONF_CURRENT_LIMIT:
615 *data = std_gvar_min_max_step_array(ch_spec->current);
617 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
618 *data = std_gvar_min_max_step_array(ch_spec->ovp);
620 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
621 *data = std_gvar_min_max_step_array(ch_spec->ocp);
631 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
633 struct dev_context *devc;
634 struct sr_scpi_dev_inst *scpi;
640 /* Prime the pipe with the first channel. */
641 devc->cur_acquisition_channel = sr_next_enabled_channel(sdi, NULL);
643 if ((ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
644 scpi_pps_receive_data, (void *)sdi)) != SR_OK)
646 std_session_send_df_header(sdi);
647 sr_sw_limits_acquisition_start(&devc->limits);
652 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
654 struct sr_scpi_dev_inst *scpi;
658 sr_scpi_source_remove(sdi->session, scpi);
660 std_session_send_df_end(sdi);
665 static struct sr_dev_driver scpi_pps_driver_info = {
667 .longname = "SCPI PPS",
670 .cleanup = std_cleanup,
671 .scan = scan_scpi_pps,
672 .dev_list = std_dev_list,
673 .dev_clear = dev_clear,
674 .config_get = config_get,
675 .config_set = config_set,
676 .config_list = config_list,
677 .dev_open = dev_open,
678 .dev_close = dev_close,
679 .dev_acquisition_start = dev_acquisition_start,
680 .dev_acquisition_stop = dev_acquisition_stop,
684 static struct sr_dev_driver hp_ib_pps_driver_info = {
686 .longname = "HP-IB PPS",
689 .cleanup = std_cleanup,
690 .scan = scan_hpib_pps,
691 .dev_list = std_dev_list,
692 .dev_clear = dev_clear,
693 .config_get = config_get,
694 .config_set = config_set,
695 .config_list = config_list,
696 .dev_open = dev_open,
697 .dev_close = dev_close,
698 .dev_acquisition_start = dev_acquisition_start,
699 .dev_acquisition_stop = dev_acquisition_stop,
702 SR_REGISTER_DEV_DRIVER(scpi_pps_driver_info);
703 SR_REGISTER_DEV_DRIVER(hp_ib_pps_driver_info);