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)
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;
105 if (device->num_channels) {
106 /* Static channels and groups. */
107 channels = (struct channel_spec *)device->channels;
108 num_channels = device->num_channels;
109 channel_groups = (struct channel_group_spec *)device->channel_groups;
110 num_channel_groups = device->num_channel_groups;
112 /* Channels and groups need to be probed. */
113 ret = device->probe_channels(sdi, hw_info, &channels, &num_channels,
114 &channel_groups, &num_channel_groups);
116 sr_err("Failed to probe for channels.");
120 * Since these were dynamically allocated, we'll need to free them
123 devc->channels = channels;
124 devc->channel_groups = channel_groups;
128 for (ch_num = 0; ch_num < num_channels; ch_num++) {
129 /* Create one channel per measurable output unit. */
130 for (i = 0; i < ARRAY_SIZE(pci); i++) {
131 if (!scpi_cmd_get(devc->device->commands, pci[i].command))
133 g_snprintf(ch_name, 16, "%s%s", pci[i].prefix,
134 channels[ch_num].name);
135 ch = sr_channel_new(sdi, ch_idx++, SR_CHANNEL_ANALOG, TRUE,
137 pch = g_malloc0(sizeof(struct pps_channel));
138 pch->hw_output_idx = ch_num;
139 pch->hwname = channels[ch_num].name;
145 for (i = 0; i < num_channel_groups; i++) {
146 cgs = &channel_groups[i];
147 cg = g_malloc0(sizeof(struct sr_channel_group));
148 cg->name = g_strdup(cgs->name);
149 for (j = 0, mask = 1; j < 64; j++, mask <<= 1) {
150 if (cgs->channel_index_mask & mask) {
151 for (l = sdi->channels; l; l = l->next) {
154 if (pch->hw_output_idx == j)
155 cg->channels = g_slist_append(cg->channels, ch);
159 pcg = g_malloc0(sizeof(struct pps_channel_group));
160 pcg->features = cgs->features;
162 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
165 sr_scpi_hw_info_free(hw_info);
168 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_LOCAL);
173 static gchar *hpib_get_revision(struct sr_scpi_dev_inst *scpi)
178 GRegex *version_regex;
180 ret = sr_scpi_get_string(scpi, "ROM?", &response);
181 if (ret != SR_OK && !response)
184 /* Example version string: "B01 B01" */
185 version_regex = g_regex_new("[A-Z][0-9]{2} [A-Z][0-9]{2}", 0, 0, NULL);
186 matches = g_regex_match(version_regex, response, 0, NULL);
187 g_regex_unref(version_regex);
190 /* Not a valid version string. Ignore it. */
194 /* Replace space with dot. */
202 * This function assumes the response is in the form "HP<model_number>"
204 * HP made many GPIB (then called HP-IB) instruments before the SCPI command
205 * set was introduced into the standard. We haven't seen any non-HP instruments
206 * which respond to the "ID?" query, so assume all are HP for now.
208 static int hpib_get_hw_id(struct sr_scpi_dev_inst *scpi,
209 struct sr_scpi_hw_info **scpi_response)
213 struct sr_scpi_hw_info *hw_info;
215 ret = sr_scpi_get_string(scpi, "ID?", &response);
216 if ((ret != SR_OK) || !response)
219 hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info));
221 *scpi_response = hw_info;
222 hw_info->model = response;
223 hw_info->firmware_version = hpib_get_revision(scpi);
224 hw_info->manufacturer = g_strdup("HP");
229 static struct sr_dev_inst *probe_scpi_pps_device(struct sr_scpi_dev_inst *scpi)
231 return probe_device(scpi, sr_scpi_get_hw_id);
234 static struct sr_dev_inst *probe_hpib_pps_device(struct sr_scpi_dev_inst *scpi)
236 return probe_device(scpi, hpib_get_hw_id);
239 static GSList *scan_scpi_pps(struct sr_dev_driver *di, GSList *options)
241 return sr_scpi_scan(di->context, options, probe_scpi_pps_device);
244 static GSList *scan_hpib_pps(struct sr_dev_driver *di, GSList *options)
246 return sr_scpi_scan(di->context, options, probe_hpib_pps_device);
249 static int dev_open(struct sr_dev_inst *sdi)
251 struct dev_context *devc;
252 struct sr_scpi_dev_inst *scpi;
255 if (sdi->status != SR_ST_INACTIVE)
259 if (sr_scpi_open(scpi) < 0)
262 sdi->status = SR_ST_ACTIVE;
265 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_REMOTE);
266 devc->beeper_was_set = FALSE;
267 if (scpi_cmd_resp(sdi, devc->device->commands, &beeper,
268 G_VARIANT_TYPE_BOOLEAN, SCPI_CMD_BEEPER) == SR_OK) {
269 if (g_variant_get_boolean(beeper)) {
270 devc->beeper_was_set = TRUE;
271 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_BEEPER_DISABLE);
273 g_variant_unref(beeper);
279 static int dev_close(struct sr_dev_inst *sdi)
281 struct sr_scpi_dev_inst *scpi;
282 struct dev_context *devc;
284 if (sdi->status != SR_ST_ACTIVE)
285 return SR_ERR_DEV_CLOSED;
290 if (devc->beeper_was_set)
291 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_BEEPER_ENABLE);
292 scpi_cmd(sdi, devc->device->commands, SCPI_CMD_LOCAL);
294 sdi->status = SR_ST_INACTIVE;
300 static void clear_helper(void *priv)
302 struct dev_context *devc;
305 g_free(devc->channels);
306 g_free(devc->channel_groups);
310 static int dev_clear(const struct sr_dev_driver *di)
312 return std_dev_clear(di, clear_helper);
315 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
316 const struct sr_channel_group *cg)
318 struct dev_context *devc;
319 const GVariantType *gvtype;
331 * These options only apply to channel groups with a single
332 * channel -- they're per-channel settings for the device.
336 * Config keys are handled below depending on whether a channel
337 * group was provided by the frontend. However some of these
338 * take a CG on one PPS but not on others. Check the device's
339 * profile for that here, and NULL out the channel group as needed.
341 for (i = 0; i < devc->device->num_devopts; i++) {
342 if (devc->device->devopts[i] == key) {
352 case SR_CONF_ENABLED:
353 gvtype = G_VARIANT_TYPE_BOOLEAN;
354 cmd = SCPI_CMD_GET_OUTPUT_ENABLED;
356 case SR_CONF_VOLTAGE:
357 gvtype = G_VARIANT_TYPE_DOUBLE;
358 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
360 case SR_CONF_VOLTAGE_TARGET:
361 gvtype = G_VARIANT_TYPE_DOUBLE;
362 cmd = SCPI_CMD_GET_VOLTAGE_TARGET;
364 case SR_CONF_OUTPUT_FREQUENCY:
365 gvtype = G_VARIANT_TYPE_DOUBLE;
366 cmd = SCPI_CMD_GET_MEAS_FREQUENCY;
368 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
369 gvtype = G_VARIANT_TYPE_DOUBLE;
370 cmd = SCPI_CMD_GET_FREQUENCY_TARGET;
372 case SR_CONF_CURRENT:
373 gvtype = G_VARIANT_TYPE_DOUBLE;
374 cmd = SCPI_CMD_GET_MEAS_CURRENT;
376 case SR_CONF_CURRENT_LIMIT:
377 gvtype = G_VARIANT_TYPE_DOUBLE;
378 cmd = SCPI_CMD_GET_CURRENT_LIMIT;
380 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
381 gvtype = G_VARIANT_TYPE_BOOLEAN;
382 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED;
384 case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
385 gvtype = G_VARIANT_TYPE_BOOLEAN;
386 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE;
388 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
389 gvtype = G_VARIANT_TYPE_DOUBLE;
390 cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD;
392 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
393 gvtype = G_VARIANT_TYPE_BOOLEAN;
394 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED;
396 case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
397 gvtype = G_VARIANT_TYPE_BOOLEAN;
398 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE;
400 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
401 gvtype = G_VARIANT_TYPE_DOUBLE;
402 cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD;
404 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
405 gvtype = G_VARIANT_TYPE_BOOLEAN;
406 cmd = SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION;
408 case SR_CONF_REGULATION:
409 gvtype = G_VARIANT_TYPE_STRING;
410 cmd = SCPI_CMD_GET_OUTPUT_REGULATION;
416 select_channel(sdi, cg->channels->data);
417 ret = scpi_cmd_resp(sdi, devc->device->commands, data, gvtype, cmd);
419 if (cmd == SCPI_CMD_GET_OUTPUT_REGULATION) {
421 * The Rigol DP800 series return CV/CC/UR, Philips PM2800
422 * return VOLT/CURR. We always return a GVariant string in
423 * the Rigol notation.
425 s = g_variant_get_string(*data, NULL);
426 if (!strcmp(s, "VOLT")) {
427 g_variant_unref(*data);
428 *data = g_variant_new_string("CV");
429 } else if (!strcmp(s, "CURR")) {
430 g_variant_unref(*data);
431 *data = g_variant_new_string("CC");
434 s = g_variant_get_string(*data, NULL);
435 if (strcmp(s, "CV") && strcmp(s, "CC") && strcmp(s, "UR")) {
436 sr_dbg("Unknown response to SCPI_CMD_GET_OUTPUT_REGULATION: %s", s);
444 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
445 const struct sr_channel_group *cg)
447 struct dev_context *devc;
454 if (sdi->status != SR_ST_ACTIVE)
455 return SR_ERR_DEV_CLOSED;
458 /* Channel group specified. */
459 select_channel(sdi, cg->channels->data);
464 case SR_CONF_ENABLED:
465 if (g_variant_get_boolean(data))
466 ret = scpi_cmd(sdi, devc->device->commands,
467 SCPI_CMD_SET_OUTPUT_ENABLE);
469 ret = scpi_cmd(sdi, devc->device->commands,
470 SCPI_CMD_SET_OUTPUT_DISABLE);
472 case SR_CONF_VOLTAGE_TARGET:
473 d = g_variant_get_double(data);
474 ret = scpi_cmd(sdi, devc->device->commands,
475 SCPI_CMD_SET_VOLTAGE_TARGET, d);
477 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
478 d = g_variant_get_double(data);
479 ret = scpi_cmd(sdi, devc->device->commands,
480 SCPI_CMD_SET_FREQUENCY_TARGET, d);
482 case SR_CONF_CURRENT_LIMIT:
483 d = g_variant_get_double(data);
484 ret = scpi_cmd(sdi, devc->device->commands,
485 SCPI_CMD_SET_CURRENT_LIMIT, d);
487 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
488 if (g_variant_get_boolean(data))
489 ret = scpi_cmd(sdi, devc->device->commands,
490 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLE);
492 ret = scpi_cmd(sdi, devc->device->commands,
493 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_DISABLE);
495 case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
496 d = g_variant_get_double(data);
497 ret = scpi_cmd(sdi, devc->device->commands,
498 SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD, d);
500 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
501 if (g_variant_get_boolean(data))
502 ret = scpi_cmd(sdi, devc->device->commands,
503 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLE);
505 ret = scpi_cmd(sdi, devc->device->commands,
506 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_DISABLE);
508 case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
509 d = g_variant_get_double(data);
510 ret = scpi_cmd(sdi, devc->device->commands,
511 SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD, d);
513 case SR_CONF_OVER_TEMPERATURE_PROTECTION:
514 if (g_variant_get_boolean(data))
515 ret = scpi_cmd(sdi, devc->device->commands,
516 SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_ENABLE);
518 ret = scpi_cmd(sdi, devc->device->commands,
519 SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_DISABLE);
528 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
529 const struct sr_channel_group *cg)
531 struct dev_context *devc;
532 struct sr_channel *ch;
533 const struct channel_spec *ch_spec;
539 /* Always available, even without sdi. */
540 if (key == SR_CONF_SCAN_OPTIONS) {
541 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
542 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
544 } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
545 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
546 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
556 /* No channel group: global options. */
558 case SR_CONF_DEVICE_OPTIONS:
559 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
560 devc->device->devopts, devc->device->num_devopts,
563 case SR_CONF_CHANNEL_CONFIG:
566 if (devc->device->features & PPS_INDEPENDENT)
567 s[i++] = "Independent";
568 if (devc->device->features & PPS_SERIES)
570 if (devc->device->features & PPS_PARALLEL)
574 * Shouldn't happen: independent-only devices
575 * shouldn't advertise this option at all.
579 *data = g_variant_new_strv(s, i);
585 /* Channel group specified. */
587 * Per-channel-group options depending on a channel are actually
588 * done with the first channel. Channel groups in PPS can have
589 * more than one channel, but they will typically be of equal
590 * specification for use in series or parallel mode.
592 ch = cg->channels->data;
595 case SR_CONF_DEVICE_OPTIONS:
596 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
597 devc->device->devopts_cg, devc->device->num_devopts_cg,
600 case SR_CONF_VOLTAGE_TARGET:
601 ch_spec = &(devc->device->channels[ch->index]);
602 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
603 /* Min, max, write resolution. */
604 for (i = 0; i < 3; i++) {
605 gvar = g_variant_new_double(ch_spec->voltage[i]);
606 g_variant_builder_add_value(&gvb, gvar);
608 *data = g_variant_builder_end(&gvb);
610 case SR_CONF_OUTPUT_FREQUENCY_TARGET:
611 ch_spec = &(devc->device->channels[ch->index]);
612 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
613 /* Min, max, write resolution. */
614 for (i = 0; i < 3; i++) {
615 gvar = g_variant_new_double(ch_spec->frequency[i]);
616 g_variant_builder_add_value(&gvb, gvar);
618 *data = g_variant_builder_end(&gvb);
620 case SR_CONF_CURRENT_LIMIT:
621 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
622 /* Min, max, step. */
623 for (i = 0; i < 3; i++) {
624 ch_spec = &(devc->device->channels[ch->index]);
625 gvar = g_variant_new_double(ch_spec->current[i]);
626 g_variant_builder_add_value(&gvb, gvar);
628 *data = g_variant_builder_end(&gvb);
638 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
640 struct dev_context *devc;
641 struct sr_scpi_dev_inst *scpi;
642 struct sr_channel *ch;
643 struct pps_channel *pch;
646 if (sdi->status != SR_ST_ACTIVE)
647 return SR_ERR_DEV_CLOSED;
652 if ((ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
653 scpi_pps_receive_data, (void *)sdi)) != SR_OK)
655 std_session_send_df_header(sdi, LOG_PREFIX);
657 /* Prime the pipe with the first channel's fetch. */
658 ch = sr_next_enabled_channel(sdi, NULL);
660 if ((ret = select_channel(sdi, ch)) < 0)
662 if (pch->mq == SR_MQ_VOLTAGE)
663 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
664 else if (pch->mq == SR_MQ_FREQUENCY)
665 cmd = SCPI_CMD_GET_MEAS_FREQUENCY;
666 else if (pch->mq == SR_MQ_CURRENT)
667 cmd = SCPI_CMD_GET_MEAS_CURRENT;
668 else if (pch->mq == SR_MQ_POWER)
669 cmd = SCPI_CMD_GET_MEAS_POWER;
672 scpi_cmd(sdi, devc->device->commands, cmd, pch->hwname);
677 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
679 struct sr_scpi_dev_inst *scpi;
682 if (sdi->status != SR_ST_ACTIVE)
683 return SR_ERR_DEV_CLOSED;
688 * A requested value is certainly on the way. Retrieve it now,
689 * to avoid leaving the device in a state where it's not expecting
692 sr_scpi_get_float(scpi, NULL, &f);
693 sr_scpi_source_remove(sdi->session, scpi);
695 std_session_send_df_end(sdi, LOG_PREFIX);
700 static struct sr_dev_driver scpi_pps_driver_info = {
702 .longname = "SCPI PPS",
705 .cleanup = std_cleanup,
706 .scan = scan_scpi_pps,
707 .dev_list = std_dev_list,
708 .dev_clear = dev_clear,
709 .config_get = config_get,
710 .config_set = config_set,
711 .config_list = config_list,
712 .dev_open = dev_open,
713 .dev_close = dev_close,
714 .dev_acquisition_start = dev_acquisition_start,
715 .dev_acquisition_stop = dev_acquisition_stop,
719 static struct sr_dev_driver hp_ib_pps_driver_info = {
721 .longname = "HP-IB PPS",
724 .cleanup = std_cleanup,
725 .scan = scan_hpib_pps,
726 .dev_list = std_dev_list,
727 .dev_clear = dev_clear,
728 .config_get = config_get,
729 .config_set = config_set,
730 .config_list = config_list,
731 .dev_open = dev_open,
732 .dev_close = dev_close,
733 .dev_acquisition_start = dev_acquisition_start,
734 .dev_acquisition_stop = dev_acquisition_stop,
737 SR_REGISTER_DEV_DRIVER(scpi_pps_driver_info);
738 SR_REGISTER_DEV_DRIVER(hp_ib_pps_driver_info);