]> sigrok.org Git - libsigrok.git/blob - src/hardware/scpi-pps/profiles.c
scpi-pps: Publish driver options.
[libsigrok.git] / src / hardware / scpi-pps / profiles.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 #include <string.h>
21 #include "protocol.h"
22
23 #define CH_IDX(x) (1 << x)
24
25 const char *pps_vendors[][2] = {
26         { "RIGOL TECHNOLOGIES", "Rigol" },
27         { "HEWLETT-PACKARD", "HP" },
28         { "PHILIPS", "Philips" },
29 };
30
31 const char *get_vendor(const char *raw_vendor)
32 {
33         unsigned int i;
34
35         for (i = 0; i < ARRAY_SIZE(pps_vendors); i++) {
36                 if (!strcasecmp(raw_vendor, pps_vendors[i][0]))
37                         return pps_vendors[i][1];
38         }
39
40         return raw_vendor;
41 }
42
43 static const uint32_t devopts_none[] = { };
44
45 /* Rigol DP800 series */
46 static const uint32_t rigol_dp800_devopts[] = {
47         SR_CONF_OVER_TEMPERATURE_PROTECTION | SR_CONF_GET | SR_CONF_SET,
48 };
49
50 static const uint32_t rigol_dp800_devopts_cg[] = {
51         SR_CONF_OUTPUT_REGULATION | SR_CONF_GET,
52         SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
53         SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE | SR_CONF_GET,
54         SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD | SR_CONF_GET | SR_CONF_SET,
55         SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
56         SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE | SR_CONF_GET,
57         SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD | SR_CONF_GET | SR_CONF_SET,
58         SR_CONF_OUTPUT_VOLTAGE | SR_CONF_GET,
59         SR_CONF_OUTPUT_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
60         SR_CONF_OUTPUT_CURRENT | SR_CONF_GET,
61         SR_CONF_OUTPUT_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
62         SR_CONF_OUTPUT_ENABLED | SR_CONF_GET | SR_CONF_SET,
63 };
64
65 struct channel_spec rigol_dp831_ch[] = {
66         { "1", { 0, 8, 0.001 }, { 0, 5, 0.0003 } },
67         { "2", { 0, 30, 0.001 }, { 0, 2, 0.0001 } },
68         { "3", { 0, -30, 0.001 }, { 0, 2, 0.0001 } },
69 };
70
71 struct channel_spec rigol_dp832_ch[] = {
72         { "1", { 0, 30, 0.001 }, { 0, 3, 0.001 } },
73         { "2", { 0, 30, 0.001 }, { 0, 3, 0.001 } },
74         { "3", { 0, 5, 0.001 }, { 0, 3, 0.001 } },
75 };
76
77 struct channel_group_spec rigol_dp800_cg[] = {
78         { "1", CH_IDX(0), PPS_OVP | PPS_OCP },
79         { "2", CH_IDX(1), PPS_OVP | PPS_OCP },
80         { "3", CH_IDX(2), PPS_OVP | PPS_OCP },
81 };
82
83 struct scpi_command rigol_dp800_cmd[] = {
84         { SCPI_CMD_REMOTE, "SYST:REMOTE" },
85         { SCPI_CMD_LOCAL, "SYST:LOCAL" },
86         { SCPI_CMD_BEEPER, "SYST:BEEP:STAT?" },
87         { SCPI_CMD_BEEPER_ENABLE, "SYST:BEEP:STAT ON" },
88         { SCPI_CMD_BEEPER_DISABLE, "SYST:BEEP:STAT OFF" },
89         { SCPI_CMD_SELECT_CHANNEL, ":INST:NSEL %s" },
90         { SCPI_CMD_GET_MEAS_VOLTAGE, ":MEAS:VOLT?" },
91         { SCPI_CMD_GET_MEAS_CURRENT, ":MEAS:CURR?" },
92         { SCPI_CMD_GET_MEAS_POWER, ":MEAS:POWE?" },
93         { SCPI_CMD_GET_VOLTAGE_TARGET, ":SOUR:VOLT?" },
94         { SCPI_CMD_SET_VOLTAGE_TARGET, ":SOUR:VOLT %.6f" },
95         { SCPI_CMD_GET_CURRENT_LIMIT, ":SOUR:CURR?" },
96         { SCPI_CMD_SET_CURRENT_LIMIT, ":SOUR:CURR %.6f" },
97         { SCPI_CMD_GET_OUTPUT_ENABLED, ":OUTP?" },
98         { SCPI_CMD_SET_OUTPUT_ENABLE, ":OUTP ON" },
99         { SCPI_CMD_SET_OUTPUT_DISABLE, ":OUTP OFF" },
100         { SCPI_CMD_GET_OUTPUT_REGULATION, ":OUTP:MODE?" },
101         { SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION, ":SYST:OTP?" },
102         { SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_ENABLE, ":SYST:OTP ON" },
103         { SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_DISABLE, ":SYST:OTP OFF" },
104         { SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED, ":OUTP:OVP?" },
105         { SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLE, ":OUTP:OVP ON" },
106         { SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_DISABLE, ":OUTP:OVP OFF" },
107         { SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE, ":OUTP:OVP:QUES?" },
108         { SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD, ":OUTP:OVP:VAL?" },
109         { SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD, ":OUTP:OVP:VAL %.6f" },
110         { SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED, ":OUTP:OCP?" },
111         { SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLE, ":OUTP:OCP:STAT ON" },
112         { SCPI_CMD_SET_OVER_CURRENT_PROTECTION_DISABLE, ":OUTP:OCP:STAT OFF" },
113         { SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE, ":OUTP:OCP:QUES?" },
114         { SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD, ":OUTP:OCP:VAL?" },
115         { SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD, ":OUTP:OCP:VAL %.6f" },
116 };
117
118 /* HP 663xx series */
119 static const uint32_t hp_6632b_devopts[] = {
120         SR_CONF_OUTPUT_ENABLED | SR_CONF_GET | SR_CONF_SET,
121         SR_CONF_OUTPUT_VOLTAGE | SR_CONF_GET,
122         SR_CONF_OUTPUT_CURRENT | SR_CONF_GET,
123         SR_CONF_OUTPUT_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
124         SR_CONF_OUTPUT_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
125 };
126
127 struct channel_spec hp_6632b_ch[] = {
128         { "1", { 0, 20.475, 0.005 }, { 0, 5.1188, 0.00132 } },
129 };
130
131 struct channel_group_spec hp_6632b_cg[] = {
132         { "1", CH_IDX(0), 0 },
133 };
134
135 struct scpi_command hp_6632b_cmd[] = {
136         { SCPI_CMD_GET_OUTPUT_ENABLED, "OUTP:STAT?" },
137         { SCPI_CMD_SET_OUTPUT_ENABLE, "OUTP:STAT ON" },
138         { SCPI_CMD_SET_OUTPUT_DISABLE, "OUTP:STAT OFF" },
139         { SCPI_CMD_GET_MEAS_VOLTAGE, ":MEAS:VOLT?" },
140         { SCPI_CMD_GET_MEAS_CURRENT, ":MEAS:CURR?" },
141         { SCPI_CMD_GET_VOLTAGE_TARGET, ":SOUR:VOLT?" },
142         { SCPI_CMD_SET_VOLTAGE_TARGET, ":SOUR:VOLT %.6f" },
143         { SCPI_CMD_GET_CURRENT_LIMIT, ":SOUR:CURR?" },
144         { SCPI_CMD_SET_CURRENT_LIMIT, ":SOUR:CURR %.6f" },
145 };
146
147 /* Philips/Fluke PM2800 series */
148 static const uint32_t philips_pm2800_devopts_cg[] = {
149         SR_CONF_OUTPUT_ENABLED | SR_CONF_GET | SR_CONF_SET,
150         SR_CONF_OUTPUT_VOLTAGE | SR_CONF_GET,
151         SR_CONF_OUTPUT_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
152         SR_CONF_OUTPUT_CURRENT | SR_CONF_GET,
153         SR_CONF_OUTPUT_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
154         SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE | SR_CONF_GET,
155         SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD | SR_CONF_GET | SR_CONF_SET,
156         SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
157         SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE | SR_CONF_GET,
158         SR_CONF_OUTPUT_REGULATION | SR_CONF_GET,
159 };
160
161 enum philips_pm2800_modules {
162         PM2800_MOD_30V_10A = 1,
163         PM2800_MOD_60V_5A,
164         PM2800_MOD_60V_10A,
165         PM2800_MOD_8V_15A,
166         PM2800_MOD_60V_2A,
167         PM2800_MOD_120V_1A,
168 };
169
170 static struct philips_pm2800_module_spec {
171         /* Min, max, programming resolution. */
172         float voltage[3];
173         float current[3];
174 } philips_pm2800_module_specs[] = {
175         /* Autoranging modules. */
176         [PM2800_MOD_30V_10A] = { { 0, 30, 0.0075 }, { 0, 10, 0.0025 } },
177         [PM2800_MOD_60V_5A] = { { 0, 60, 0.015 }, { 0, 5, 0.00125 } },
178         [PM2800_MOD_60V_10A] = { { 0, 60, 0.015 }, { 0, 10, 0.0025 } },
179         /* Linear modules. */
180         [PM2800_MOD_8V_15A] = { { 0, 8, 0.002 }, { -15, 15, 0.00375 } },
181         [PM2800_MOD_60V_2A] = { { 0, 60, 0.015 }, { -2, 2, 0.0005 } },
182         [PM2800_MOD_120V_1A] = { { 0, 120, 0.030 }, { -1, 1, 0.00025 } },
183 };
184
185 static struct philips_pm2800_model {
186         unsigned int chassis;
187         unsigned int num_modules;
188         unsigned int set;
189         unsigned int modules[3];
190 } philips_pm2800_matrix[] = {
191         /* Autoranging chassis. */
192         { 1, 1, 0, { PM2800_MOD_30V_10A, 0, 0 } },
193         { 1, 1, 1, { PM2800_MOD_60V_5A, 0, 0 } },
194         { 1, 2, 0, { PM2800_MOD_30V_10A, PM2800_MOD_30V_10A, 0 } },
195         { 1, 2, 1, { PM2800_MOD_60V_5A, PM2800_MOD_60V_5A, 0 } },
196         { 1, 2, 2, { PM2800_MOD_30V_10A, PM2800_MOD_60V_5A, 0 } },
197         { 1, 2, 3, { PM2800_MOD_30V_10A, PM2800_MOD_60V_10A, 0 } },
198         { 1, 2, 4, { PM2800_MOD_60V_5A, PM2800_MOD_60V_10A, 0 } },
199         { 1, 3, 0, { PM2800_MOD_30V_10A, PM2800_MOD_30V_10A, PM2800_MOD_30V_10A } },
200         { 1, 3, 1, { PM2800_MOD_60V_5A, PM2800_MOD_60V_5A, PM2800_MOD_60V_5A } },
201         { 1, 3, 2, { PM2800_MOD_30V_10A, PM2800_MOD_30V_10A, PM2800_MOD_60V_5A } },
202         { 1, 3, 3, { PM2800_MOD_30V_10A, PM2800_MOD_60V_5A, PM2800_MOD_60V_5A } },
203         /* Linear chassis. */
204         { 3, 1, 0, { PM2800_MOD_60V_2A, 0, 0 } },
205         { 3, 1, 1, { PM2800_MOD_120V_1A, 0, 0 } },
206         { 3, 1, 2, { PM2800_MOD_8V_15A, 0, 0 } },
207         { 3, 2, 0, { PM2800_MOD_60V_2A, 0, 0 } },
208         { 3, 2, 1, { PM2800_MOD_120V_1A, 0, 0 } },
209         { 3, 2, 2, { PM2800_MOD_60V_2A, PM2800_MOD_120V_1A, 0 } },
210         { 3, 2, 3, { PM2800_MOD_8V_15A, PM2800_MOD_8V_15A, 0 } },
211 };
212
213 static char *philips_pm2800_names[] = { "1", "2", "3" };
214
215 static int philips_pm2800_probe_channels(struct sr_dev_inst *sdi,
216                 struct sr_scpi_hw_info *hw_info,
217                 struct channel_spec **channels, unsigned int *num_channels,
218                 struct channel_group_spec **channel_groups, unsigned int *num_channel_groups)
219 {
220         struct philips_pm2800_model *model;
221         struct philips_pm2800_module_spec *spec;
222         unsigned int chassis, num_modules, set, module, m, i;
223
224         (void)sdi;
225
226         /*
227          * The model number as reported by *IDN? looks like e.g. PM2813/11,
228          * Where "PM28" is fixed, followed by the chassis code (1 = autoranging,
229          * 3 = linear series) and the number of modules: 1-3 for autoranging,
230          * 1-2 for linear.
231          * After the slash, the first digit denotes the module set. The
232          * digit after that denotes front (5) or rear (1) binding posts.
233          */
234         chassis = hw_info->model[4] - 0x30;
235         num_modules = hw_info->model[5] - 0x30;
236         set = hw_info->model[7] - 0x30;
237         for (m = 0; m < ARRAY_SIZE(philips_pm2800_matrix); m++) {
238                 model = &philips_pm2800_matrix[m];
239                 if (model->chassis == chassis && model->num_modules == num_modules
240                                 && model->set == set)
241                         break;
242         }
243         if (m == ARRAY_SIZE(philips_pm2800_matrix)) {
244                 sr_dbg("Model %s not found in matrix.", hw_info->model);
245                 return SR_ERR;
246         }
247
248         sr_dbg("Found %d output channel%s:", num_modules, num_modules > 1 ? "s" : "");
249         *channels = g_malloc0(sizeof(struct channel_spec) * num_modules);
250         *channel_groups = g_malloc0(sizeof(struct channel_group_spec) * num_modules);
251         for (i = 0; i < num_modules; i++) {
252                 module = model->modules[i];
253                 spec = &philips_pm2800_module_specs[module];
254                 sr_dbg("output %d: %.0f - %.0fV, %.0f - %.0fA", i + 1,
255                                 spec->voltage[0], spec->voltage[1],
256                                 spec->current[0], spec->current[1]);
257                 (*channels)[i].name = philips_pm2800_names[i];
258                 memcpy(&((*channels)[i].voltage), spec, sizeof(float) * 6);
259                 (*channel_groups)[i].name = philips_pm2800_names[i];
260                 (*channel_groups)[i].channel_index_mask = 1 << i;
261                 (*channel_groups)[i].features = PPS_OTP | PPS_OVP | PPS_OCP;
262         }
263         *num_channels = *num_channel_groups = num_modules;
264
265         return SR_OK;
266 }
267
268 struct scpi_command philips_pm2800_cmd[] = {
269         { SCPI_CMD_SELECT_CHANNEL, ":INST:NSEL %s" },
270         { SCPI_CMD_GET_MEAS_VOLTAGE, ":MEAS:VOLT?" },
271         { SCPI_CMD_GET_MEAS_CURRENT, ":MEAS:CURR?" },
272         { SCPI_CMD_GET_VOLTAGE_TARGET, ":SOUR:VOLT?" },
273         { SCPI_CMD_SET_VOLTAGE_TARGET, ":SOUR:VOLT %.6f" },
274         { SCPI_CMD_GET_CURRENT_LIMIT, ":SOUR:CURR?" },
275         { SCPI_CMD_SET_CURRENT_LIMIT, ":SOUR:CURR %.6f" },
276         { SCPI_CMD_GET_OUTPUT_ENABLED, ":OUTP?" },
277         { SCPI_CMD_SET_OUTPUT_ENABLE, ":OUTP ON" },
278         { SCPI_CMD_SET_OUTPUT_DISABLE, ":OUTP OFF" },
279         { SCPI_CMD_GET_OUTPUT_REGULATION, ":SOUR:FUNC:MODE?" },
280         { SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE, ":SOUR:VOLT:PROT:TRIP?" },
281         { SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD, ":SOUR:VOLT:PROT:LEV?" },
282         { SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD, ":SOUR:VOLT:PROT:LEV %.6f" },
283         { SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED, ":SOUR:CURR:PROT:STAT?" },
284         { SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLE, ":SOUR:CURR:PROT:STAT ON" },
285         { SCPI_CMD_SET_OVER_CURRENT_PROTECTION_DISABLE, ":SOUR:CURR:PROT:STAT OFF" },
286         { SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE, ":SOUR:CURR:PROT:TRIP?" },
287 };
288
289
290 SR_PRIV const struct scpi_pps pps_profiles[] = {
291         /* HP 6632B */
292         { "HP", "6632B", 0,
293                 ARRAY_AND_SIZE(hp_6632b_devopts),
294                 ARRAY_AND_SIZE(devopts_none),
295                 ARRAY_AND_SIZE(hp_6632b_ch),
296                 ARRAY_AND_SIZE(hp_6632b_cg),
297                 ARRAY_AND_SIZE(hp_6632b_cmd),
298                 .probe_channels = NULL,
299         },
300
301         /* Rigol DP800 series */
302         { "Rigol", "^DP831A$", PPS_OTP,
303                 ARRAY_AND_SIZE(rigol_dp800_devopts),
304                 ARRAY_AND_SIZE(rigol_dp800_devopts_cg),
305                 ARRAY_AND_SIZE(rigol_dp831_ch),
306                 ARRAY_AND_SIZE(rigol_dp800_cg),
307                 ARRAY_AND_SIZE(rigol_dp800_cmd),
308                 .probe_channels = NULL,
309         },
310         { "Rigol", "^(DP832|DP832A)$", PPS_OTP,
311                 ARRAY_AND_SIZE(rigol_dp800_devopts),
312                 ARRAY_AND_SIZE(rigol_dp800_devopts_cg),
313                 ARRAY_AND_SIZE(rigol_dp832_ch),
314                 ARRAY_AND_SIZE(rigol_dp800_cg),
315                 ARRAY_AND_SIZE(rigol_dp800_cmd),
316                 .probe_channels = NULL,
317         },
318
319         /* Philips/Fluke PM2800 series */
320         { "Philips", "^PM28[13][123]/[01234]{1,2}$", 0,
321                 ARRAY_AND_SIZE(devopts_none),
322                 ARRAY_AND_SIZE(philips_pm2800_devopts_cg),
323                 NULL, 0,
324                 NULL, 0,
325                 ARRAY_AND_SIZE(philips_pm2800_cmd),
326                 philips_pm2800_probe_channels,
327         },
328 };
329 SR_PRIV unsigned int num_pps_profiles = ARRAY_SIZE(pps_profiles);
330