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 static struct sr_dev_driver scpi_pps_driver_info;
27 static struct sr_dev_driver hp_ib_pps_driver_info;
29 static const uint32_t scanopts[] = {
34 static const uint32_t drvopts[] = {
38 static const struct pps_channel_instance pci[] = {
39 { SR_MQ_VOLTAGE, SCPI_CMD_GET_MEAS_VOLTAGE, "V" },
40 { SR_MQ_CURRENT, SCPI_CMD_GET_MEAS_CURRENT, "I" },
41 { SR_MQ_POWER, SCPI_CMD_GET_MEAS_POWER, "P" },
42 { SR_MQ_FREQUENCY, SCPI_CMD_GET_MEAS_FREQUENCY, "F" },
45 static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi,
46 int (*get_hw_id)(struct sr_scpi_dev_inst *scpi,
47 struct sr_scpi_hw_info **scpi_response))
49 struct dev_context *devc;
50 struct sr_dev_inst *sdi;
51 struct sr_scpi_hw_info *hw_info;
52 struct sr_channel_group *cg;
53 struct sr_channel *ch;
54 const struct scpi_pps *device;
55 struct pps_channel *pch;
56 struct channel_spec *channels;
57 struct channel_group_spec *channel_groups, *cgs;
58 struct pps_channel_group *pcg;
63 unsigned int num_channels, num_channel_groups, ch_num, ch_idx, i, j;
68 if (get_hw_id(scpi, &hw_info) != SR_OK) {
69 sr_info("Couldn't get IDN response.");
74 for (i = 0; i < num_pps_profiles; i++) {
75 vendor = sr_vendor_alias(hw_info->manufacturer);
76 if (g_ascii_strcasecmp(vendor, pps_profiles[i].vendor))
78 model_re = g_regex_new(pps_profiles[i].model, 0, 0, NULL);
79 if (g_regex_match(model_re, hw_info->model, 0, &model_mi))
80 device = &pps_profiles[i];
81 g_match_info_unref(model_mi);
82 g_regex_unref(model_re);
87 sr_scpi_hw_info_free(hw_info);
91 sdi = g_malloc0(sizeof(struct sr_dev_inst));
92 sdi->vendor = g_strdup(vendor);
93 sdi->model = g_strdup(hw_info->model);
94 sdi->version = g_strdup(hw_info->firmware_version);
96 sdi->driver = &scpi_pps_driver_info;
97 sdi->inst_type = SR_INST_SCPI;
98 sdi->serial_num = g_strdup(hw_info->serial_number);
100 devc = g_malloc0(sizeof(struct dev_context));
101 devc->device = device;
104 if (device->num_channels) {
105 /* Static channels and groups. */
106 channels = (struct channel_spec *)device->channels;
107 num_channels = device->num_channels;
108 channel_groups = (struct channel_group_spec *)device->channel_groups;
109 num_channel_groups = device->num_channel_groups;
111 /* Channels and groups need to be probed. */
112 ret = device->probe_channels(sdi, hw_info, &channels, &num_channels,
113 &channel_groups, &num_channel_groups);
115 sr_err("Failed to probe for channels.");
119 * Since these were dynamically allocated, we'll need to free them
122 devc->channels = channels;
123 devc->channel_groups = channel_groups;
127 for (ch_num = 0; ch_num < num_channels; ch_num++) {
128 /* Create one channel per measurable output unit. */
129 for (i = 0; i < ARRAY_SIZE(pci); i++) {
130 if (!scpi_cmd_get(devc->device->commands, pci[i].command))
132 g_snprintf(ch_name, 16, "%s%s", pci[i].prefix,
133 channels[ch_num].name);
134 ch = sr_channel_new(sdi, ch_idx++, SR_CHANNEL_ANALOG, TRUE,
136 pch = g_malloc0(sizeof(struct pps_channel));
137 pch->hw_output_idx = ch_num;
138 pch->hwname = channels[ch_num].name;
144 for (i = 0; i < num_channel_groups; i++) {
145 cgs = &channel_groups[i];
146 cg = g_malloc0(sizeof(struct sr_channel_group));
147 cg->name = g_strdup(cgs->name);
148 for (j = 0, mask = 1; j < 64; j++, mask <<= 1) {
149 if (cgs->channel_index_mask & mask) {
150 for (l = sdi->channels; l; l = l->next) {
153 if (pch->hw_output_idx == j)
154 cg->channels = g_slist_append(cg->channels, ch);
158 pcg = g_malloc0(sizeof(struct pps_channel_group));
159 pcg->features = cgs->features;
161 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
164 sr_scpi_hw_info_free(hw_info);
167 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_LOCAL);
172 static gchar *hpib_get_revision(struct sr_scpi_dev_inst *scpi)
177 GRegex *version_regex;
179 ret = sr_scpi_get_string(scpi, "ROM?", &response);
180 if (ret != SR_OK && !response)
183 /* Example version string: "B01 B01" */
184 version_regex = g_regex_new("[A-Z][0-9]{2} [A-Z][0-9]{2}", 0, 0, NULL);
185 matches = g_regex_match(version_regex, response, 0, NULL);
186 g_regex_unref(version_regex);
189 /* Not a valid version string. Ignore it. */
193 /* Replace space with dot. */
201 * This function assumes the response is in the form "HP<model_number>"
203 * HP made many GPIB (then called HP-IB) instruments before the SCPI command
204 * set was introduced into the standard. We haven't seen any non-HP instruments
205 * which respond to the "ID?" query, so assume all are HP for now.
207 static int hpib_get_hw_id(struct sr_scpi_dev_inst *scpi,
208 struct sr_scpi_hw_info **scpi_response)
212 struct sr_scpi_hw_info *hw_info;
214 ret = sr_scpi_get_string(scpi, "ID?", &response);
215 if ((ret != SR_OK) || !response)
218 hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info));
220 *scpi_response = hw_info;
221 hw_info->model = response;
222 hw_info->firmware_version = hpib_get_revision(scpi);
223 hw_info->manufacturer = g_strdup("HP");
228 static struct sr_dev_inst *probe_scpi_pps_device(struct sr_scpi_dev_inst *scpi)
230 return probe_device(scpi, sr_scpi_get_hw_id);
233 static struct sr_dev_inst *probe_hpib_pps_device(struct sr_scpi_dev_inst *scpi)
235 return probe_device(scpi, hpib_get_hw_id);
238 static GSList *scan_scpi_pps(struct sr_dev_driver *di, GSList *options)
240 return sr_scpi_scan(di->context, options, probe_scpi_pps_device);
243 static GSList *scan_hpib_pps(struct sr_dev_driver *di, GSList *options)
245 return sr_scpi_scan(di->context, options, probe_hpib_pps_device);
248 static int dev_open(struct sr_dev_inst *sdi)
250 struct dev_context *devc;
251 struct sr_scpi_dev_inst *scpi;
254 if (sdi->status != SR_ST_INACTIVE)
258 if (sr_scpi_open(scpi) < 0)
261 sdi->status = SR_ST_ACTIVE;
264 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_REMOTE);
265 devc->beeper_was_set = FALSE;
266 if (scpi_cmd_resp(sdi, devc->device->commands, &beeper,
267 G_VARIANT_TYPE_BOOLEAN, SCPI_CMD_BEEPER) == SR_OK) {
268 if (g_variant_get_boolean(beeper)) {
269 devc->beeper_was_set = TRUE;
270 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_BEEPER_DISABLE);
272 g_variant_unref(beeper);
278 static int dev_close(struct sr_dev_inst *sdi)
280 struct sr_scpi_dev_inst *scpi;
281 struct dev_context *devc;
286 if (devc->beeper_was_set)
287 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_BEEPER_ENABLE);
288 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_LOCAL);
290 sdi->status = SR_ST_INACTIVE;
296 static void clear_helper(void *priv)
298 struct dev_context *devc;
301 g_free(devc->channels);
302 g_free(devc->channel_groups);
306 static int dev_clear(const struct sr_dev_driver *di)
308 return std_dev_clear(di, clear_helper);
311 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
312 const struct sr_channel_group *cg)
314 struct dev_context *devc;
315 const GVariantType *gvtype;
327 * These options only apply to channel groups with a single
328 * channel -- they're per-channel settings for the device.
332 * Config keys are handled below depending on whether a channel
333 * group was provided by the frontend. However some of these
334 * take a CG on one PPS but not on others. Check the device's
335 * profile for that here, and NULL out the channel group as needed.
337 for (i = 0; i < devc->device->num_devopts; i++) {
338 if (devc->device->devopts[i] == key) {
348 case SR_CONF_ENABLED:
349 gvtype = G_VARIANT_TYPE_BOOLEAN;
350 cmd = SCPI_CMD_GET_OUTPUT_ENABLED;
352 case SR_CONF_VOLTAGE:
353 gvtype = G_VARIANT_TYPE_DOUBLE;
354 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
356 case SR_CONF_VOLTAGE_TARGET:
357 gvtype = G_VARIANT_TYPE_DOUBLE;
358 cmd = SCPI_CMD_GET_VOLTAGE_TARGET;
360 case SR_CONF_OUTPUT_FREQUENCY:
361 gvtype = G_VARIANT_TYPE_DOUBLE;
362 cmd = SCPI_CMD_GET_MEAS_FREQUENCY;
364 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
365 gvtype = G_VARIANT_TYPE_DOUBLE;
366 cmd = SCPI_CMD_GET_FREQUENCY_TARGET;
368 case SR_CONF_CURRENT:
369 gvtype = G_VARIANT_TYPE_DOUBLE;
370 cmd = SCPI_CMD_GET_MEAS_CURRENT;
372 case SR_CONF_CURRENT_LIMIT:
373 gvtype = G_VARIANT_TYPE_DOUBLE;
374 cmd = SCPI_CMD_GET_CURRENT_LIMIT;
376 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
377 gvtype = G_VARIANT_TYPE_BOOLEAN;
378 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED;
380 case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
381 gvtype = G_VARIANT_TYPE_BOOLEAN;
382 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE;
384 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
385 gvtype = G_VARIANT_TYPE_DOUBLE;
386 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD;
388 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
389 gvtype = G_VARIANT_TYPE_BOOLEAN;
390 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED;
392 case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
393 gvtype = G_VARIANT_TYPE_BOOLEAN;
394 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE;
396 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
397 gvtype = G_VARIANT_TYPE_DOUBLE;
398 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD;
400 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
401 gvtype = G_VARIANT_TYPE_BOOLEAN;
402 cmd = SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION;
404 case SR_CONF_REGULATION:
405 gvtype = G_VARIANT_TYPE_STRING;
406 cmd = SCPI_CMD_GET_OUTPUT_REGULATION;
412 select_channel(sdi, cg->channels->data);
413 ret = scpi_cmd_resp(sdi, devc->device->commands, data, gvtype, cmd);
415 if (cmd == SCPI_CMD_GET_OUTPUT_REGULATION) {
417 * The Rigol DP800 series return CV/CC/UR, Philips PM2800
418 * return VOLT/CURR. We always return a GVariant string in
419 * the Rigol notation.
421 s = g_variant_get_string(*data, NULL);
422 if (!strcmp(s, "VOLT")) {
423 g_variant_unref(*data);
424 *data = g_variant_new_string("CV");
425 } else if (!strcmp(s, "CURR")) {
426 g_variant_unref(*data);
427 *data = g_variant_new_string("CC");
430 s = g_variant_get_string(*data, NULL);
431 if (strcmp(s, "CV") && strcmp(s, "CC") && strcmp(s, "UR")) {
432 sr_dbg("Unknown response to SCPI_CMD_GET_OUTPUT_REGULATION: %s", s);
440 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
441 const struct sr_channel_group *cg)
443 struct dev_context *devc;
451 /* Channel group specified. */
452 select_channel(sdi, cg->channels->data);
457 case SR_CONF_ENABLED:
458 if (g_variant_get_boolean(data))
459 ret = scpi_cmd(sdi, devc->device->commands,
460 SCPI_CMD_SET_OUTPUT_ENABLE);
462 ret = scpi_cmd(sdi, devc->device->commands,
463 SCPI_CMD_SET_OUTPUT_DISABLE);
465 case SR_CONF_VOLTAGE_TARGET:
466 d = g_variant_get_double(data);
467 ret = scpi_cmd(sdi, devc->device->commands,
468 SCPI_CMD_SET_VOLTAGE_TARGET, d);
470 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
471 d = g_variant_get_double(data);
472 ret = scpi_cmd(sdi, devc->device->commands,
473 SCPI_CMD_SET_FREQUENCY_TARGET, d);
475 case SR_CONF_CURRENT_LIMIT:
476 d = g_variant_get_double(data);
477 ret = scpi_cmd(sdi, devc->device->commands,
478 SCPI_CMD_SET_CURRENT_LIMIT, d);
480 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
481 if (g_variant_get_boolean(data))
482 ret = scpi_cmd(sdi, devc->device->commands,
483 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLE);
485 ret = scpi_cmd(sdi, devc->device->commands,
486 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_DISABLE);
488 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
489 d = g_variant_get_double(data);
490 ret = scpi_cmd(sdi, devc->device->commands,
491 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD, d);
493 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
494 if (g_variant_get_boolean(data))
495 ret = scpi_cmd(sdi, devc->device->commands,
496 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLE);
498 ret = scpi_cmd(sdi, devc->device->commands,
499 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_DISABLE);
501 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
502 d = g_variant_get_double(data);
503 ret = scpi_cmd(sdi, devc->device->commands,
504 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD, d);
506 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
507 if (g_variant_get_boolean(data))
508 ret = scpi_cmd(sdi, devc->device->commands,
509 SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_ENABLE);
511 ret = scpi_cmd(sdi, devc->device->commands,
512 SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_DISABLE);
521 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
522 const struct sr_channel_group *cg)
524 struct dev_context *devc;
525 struct sr_channel *ch;
526 const struct channel_spec *ch_spec;
532 /* Always available, even without sdi. */
533 if (key == SR_CONF_SCAN_OPTIONS) {
534 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
535 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
537 } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
538 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
539 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
549 /* No channel group: global options. */
551 case SR_CONF_DEVICE_OPTIONS:
552 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
553 devc->device->devopts, devc->device->num_devopts,
556 case SR_CONF_CHANNEL_CONFIG:
559 if (devc->device->features & PPS_INDEPENDENT)
560 s[i++] = "Independent";
561 if (devc->device->features & PPS_SERIES)
563 if (devc->device->features & PPS_PARALLEL)
567 * Shouldn't happen: independent-only devices
568 * shouldn't advertise this option at all.
572 *data = g_variant_new_strv(s, i);
578 /* Channel group specified. */
580 * Per-channel-group options depending on a channel are actually
581 * done with the first channel. Channel groups in PPS can have
582 * more than one channel, but they will typically be of equal
583 * specification for use in series or parallel mode.
585 ch = cg->channels->data;
588 case SR_CONF_DEVICE_OPTIONS:
589 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
590 devc->device->devopts_cg, devc->device->num_devopts_cg,
593 case SR_CONF_VOLTAGE_TARGET:
594 ch_spec = &(devc->device->channels[ch->index]);
595 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
596 /* Min, max, write resolution. */
597 for (i = 0; i < 3; i++) {
598 gvar = g_variant_new_double(ch_spec->voltage[i]);
599 g_variant_builder_add_value(&gvb, gvar);
601 *data = g_variant_builder_end(&gvb);
603 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
604 ch_spec = &(devc->device->channels[ch->index]);
605 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
606 /* Min, max, write resolution. */
607 for (i = 0; i < 3; i++) {
608 gvar = g_variant_new_double(ch_spec->frequency[i]);
609 g_variant_builder_add_value(&gvb, gvar);
611 *data = g_variant_builder_end(&gvb);
613 case SR_CONF_CURRENT_LIMIT:
614 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
615 /* Min, max, step. */
616 for (i = 0; i < 3; i++) {
617 ch_spec = &(devc->device->channels[ch->index]);
618 gvar = g_variant_new_double(ch_spec->current[i]);
619 g_variant_builder_add_value(&gvb, gvar);
621 *data = g_variant_builder_end(&gvb);
631 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
633 struct dev_context *devc;
634 struct sr_scpi_dev_inst *scpi;
635 struct sr_channel *ch;
636 struct pps_channel *pch;
642 if ((ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
643 scpi_pps_receive_data, (void *)sdi)) != SR_OK)
645 std_session_send_df_header(sdi);
647 /* Prime the pipe with the first channel's fetch. */
648 ch = sr_next_enabled_channel(sdi, NULL);
650 if ((ret = select_channel(sdi, ch)) < 0)
652 if (pch->mq == SR_MQ_VOLTAGE)
653 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
654 else if (pch->mq == SR_MQ_FREQUENCY)
655 cmd = SCPI_CMD_GET_MEAS_FREQUENCY;
656 else if (pch->mq == SR_MQ_CURRENT)
657 cmd = SCPI_CMD_GET_MEAS_CURRENT;
658 else if (pch->mq == SR_MQ_POWER)
659 cmd = SCPI_CMD_GET_MEAS_POWER;
662 scpi_cmd(sdi, devc->device->commands, cmd, pch->hwname);
667 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
669 struct sr_scpi_dev_inst *scpi;
675 * A requested value is certainly on the way. Retrieve it now,
676 * to avoid leaving the device in a state where it's not expecting
679 sr_scpi_get_float(scpi, NULL, &f);
680 sr_scpi_source_remove(sdi->session, scpi);
682 std_session_send_df_end(sdi);
687 static struct sr_dev_driver scpi_pps_driver_info = {
689 .longname = "SCPI PPS",
692 .cleanup = std_cleanup,
693 .scan = scan_scpi_pps,
694 .dev_list = std_dev_list,
695 .dev_clear = dev_clear,
696 .config_get = config_get,
697 .config_set = config_set,
698 .config_list = config_list,
699 .dev_open = dev_open,
700 .dev_close = dev_close,
701 .dev_acquisition_start = dev_acquisition_start,
702 .dev_acquisition_stop = dev_acquisition_stop,
706 static struct sr_dev_driver hp_ib_pps_driver_info = {
708 .longname = "HP-IB PPS",
711 .cleanup = std_cleanup,
712 .scan = scan_hpib_pps,
713 .dev_list = std_dev_list,
714 .dev_clear = dev_clear,
715 .config_get = config_get,
716 .config_set = config_set,
717 .config_list = config_list,
718 .dev_open = dev_open,
719 .dev_close = dev_close,
720 .dev_acquisition_start = dev_acquisition_start,
721 .dev_acquisition_stop = dev_acquisition_stop,
724 SR_REGISTER_DEV_DRIVER(scpi_pps_driver_info);
725 SR_REGISTER_DEV_DRIVER(hp_ib_pps_driver_info);