scpi-pps: Add a missing "break" in config_get().
[libsigrok.git] / src / hardware / gwinstek-gpd / api.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2018 Bastian Schmitz <bastian.schmitz@udo.edu>
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 <config.h>
21 #include <string.h>
22 #include "protocol.h"
23
24 static const uint32_t scanopts[] = {
25         SR_CONF_CONN,
26         SR_CONF_SERIALCOMM,
27 };
28
29 static const uint32_t drvopts[] = {
30         SR_CONF_POWER_SUPPLY,
31 };
32
33 static const uint32_t devopts[] = {
34         SR_CONF_CONTINUOUS,
35         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
36         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
37         SR_CONF_CHANNEL_CONFIG | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
38         SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
39 };
40
41 static const uint32_t devopts_cg[] = {
42         SR_CONF_VOLTAGE | SR_CONF_GET,
43         SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
44         SR_CONF_CURRENT | SR_CONF_GET,
45         SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
46 };
47
48 static const char *channel_modes[] = {
49         "Independent",
50 };
51
52 static const struct gpd_model models[] = {
53         { GPD_2303S, "GPD-2303S",
54                 CHANMODE_INDEPENDENT,
55                 2,
56                 {
57                         /* Channel 1 */
58                         { { 0, 30, 0.001 }, { 0, 3, 0.001 } },
59                         /* Channel 2 */
60                         { { 0, 30, 0.001 }, { 0, 3, 0.001 } },
61                 },
62         },
63 };
64
65 static GSList *scan(struct sr_dev_driver *di, GSList *options)
66 {
67         const char *conn, *serialcomm;
68         const struct gpd_model *model;
69         const struct sr_config *src;
70         struct sr_channel *ch;
71         struct sr_channel_group *cg;
72         GSList *l;
73         struct sr_serial_dev_inst *serial;
74         struct sr_dev_inst *sdi;
75         char reply[50];
76         unsigned int i;
77         struct dev_context *devc;
78         char channel[10];
79         GRegex *regex;
80         GMatchInfo *match_info;
81         unsigned int cc_cv_ch1, cc_cv_ch2, track1, track2, beep, baud1, baud2;
82
83         serial = NULL;
84         match_info = NULL;
85         regex = NULL;
86         conn = NULL;
87         serialcomm = NULL;
88
89         for (l = options; l; l = l->next) {
90                 src = l->data;
91                 switch (src->key) {
92                 case SR_CONF_CONN:
93                         conn = g_variant_get_string(src->data, NULL);
94                         break;
95                 case SR_CONF_SERIALCOMM:
96                         serialcomm = g_variant_get_string(src->data, NULL);
97                         break;
98                 }
99         }
100
101         if (!conn)
102                 return NULL;
103         if (!serialcomm)
104                 serialcomm = "115200/8n1";
105         sr_info("Probing serial port %s.", conn);
106         serial = sr_serial_dev_inst_new(conn, serialcomm);
107         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
108                 return NULL;
109
110         serial_flush(serial);
111         gpd_send_cmd(serial, "*IDN?\n");
112         if (gpd_receive_reply(serial, reply, sizeof(reply)) != SR_OK) {
113                 sr_err("Device did not reply.");
114                 goto error;
115         }
116         serial_flush(serial);
117
118         /*
119          * Returned identification string is for example:
120          * "GW INSTEK,GPD-2303S,SN:ER915277,V2.10"
121          */
122         regex = g_regex_new("GW INSTEK,(.+),SN:(.+),(V.+)", 0, 0, NULL);
123         if (!g_regex_match(regex, reply, 0, &match_info)) {
124                 sr_err("Unsupported model '%s'.", reply);
125                 goto error;
126         }
127
128         model = NULL;
129         for (i = 0; i < ARRAY_SIZE(models); i++) {
130                 if (!strcmp(g_match_info_fetch(match_info, 1), models[i].name)) {
131                         model = &models[i];
132                         break;
133                 }
134         }
135         if (!model) {
136                 sr_err("Unsupported model '%s'.", reply);
137                 goto error;
138         }
139
140         sr_info("Detected model '%s'.", model->name);
141
142         sdi = g_malloc0(sizeof(struct sr_dev_inst));
143         sdi->status = SR_ST_INACTIVE;
144         sdi->vendor = g_strdup("GW Instek");
145         sdi->model = g_strdup(model->name);
146         sdi->inst_type = SR_INST_SERIAL;
147         sdi->conn = serial;
148
149         for (i = 0; i < model->num_channels; i++) {
150                 snprintf(channel, sizeof(channel), "CH%d", i + 1);
151                 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel);
152                 cg = g_malloc(sizeof(struct sr_channel_group));
153                 cg->name = g_strdup(channel);
154                 cg->channels = g_slist_append(NULL, ch);
155                 cg->priv = NULL;
156                 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
157         }
158
159         devc = g_malloc0(sizeof(struct dev_context));
160         sr_sw_limits_init(&devc->limits);
161         devc->model = model;
162         devc->config = g_malloc0(sizeof(struct per_channel_config)
163                                  * model->num_channels);
164         sdi->priv = devc;
165
166         serial_flush(serial);
167         gpd_send_cmd(serial, "STATUS?\n");
168         gpd_receive_reply(serial, reply, sizeof(reply));
169
170         if (sscanf(reply, "%1u%1u%1u%1u%1u%1u%1u%1u", &cc_cv_ch1,
171                         &cc_cv_ch2, &track1, &track2, &beep,
172                         &devc->output_enabled, &baud1, &baud2) != 8) {
173                 sr_err("Invalid reply to STATUS: '%s'.", reply);
174                 goto error;
175         }
176
177         for (i = 0; i < model->num_channels; ++i) {
178                 gpd_send_cmd(serial, "ISET%d?\n", i + 1);
179                 gpd_receive_reply(serial, reply, sizeof(reply));
180                 if (sscanf(reply, "%f", &devc->config[i].output_current_max) != 1) {
181                         sr_err("Invalid reply to ISETn?: '%s'.", reply);
182                         goto error;
183                 }
184
185                 gpd_send_cmd(serial, "VSET%d?\n", i + 1);
186                 gpd_receive_reply(serial, reply, sizeof(reply));
187                 if (sscanf(reply, "%f", &devc->config[i].output_voltage_max) != 1) {
188                         sr_err("Invalid reply to VSETn?: '%s'.", reply);
189                         goto error;
190                 }
191                 gpd_send_cmd(serial, "IOUT%d?\n", i + 1);
192                 gpd_receive_reply(serial, reply, sizeof(reply));
193                 if (sscanf(reply, "%f", &devc->config[i].output_current_last) != 1) {
194                         sr_err("Invalid reply to IOUTn?: '%s'.", reply);
195                         goto error;
196                 }
197                 gpd_send_cmd(serial, "VOUT%d?\n", i + 1);
198                 gpd_receive_reply(serial, reply, sizeof(reply));
199                 if (sscanf(reply, "%f", &devc->config[i].output_voltage_last) != 1) {
200                         sr_err("Invalid reply to VOUTn?: '%s'.", reply);
201                         goto error;
202                 }
203         }
204
205         serial_close(serial);
206
207         return std_scan_complete(di, g_slist_append(NULL, sdi));
208
209 error:
210         if (match_info)
211                 g_match_info_free(match_info);
212         if (regex)
213                 g_regex_unref(regex);
214         if (serial)
215                 serial_close(serial);
216
217         return NULL;
218 }
219
220 static int config_get(uint32_t key, GVariant **data,
221         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
222 {
223         int ret, channel;
224         const struct dev_context *devc;
225         const struct sr_channel *ch;
226
227         if (!sdi)
228                 return SR_ERR_ARG;
229
230         devc = sdi->priv;
231
232         if (!cg) {
233                 switch (key) {
234                 case SR_CONF_CHANNEL_CONFIG:
235                         *data = g_variant_new_string(
236                                 channel_modes[devc->channel_mode]);
237                         break;
238                 case SR_CONF_ENABLED:
239                         *data = g_variant_new_boolean(devc->output_enabled);
240                         break;
241                 default:
242                         return SR_ERR_NA;
243                 }
244         } else {
245                 ch = cg->channels->data;
246                 channel = ch->index;
247                 ret = SR_OK;
248                 switch (key) {
249                 case SR_CONF_VOLTAGE:
250                         *data = g_variant_new_double(
251                                 devc->config[channel].output_voltage_last);
252                         break;
253                 case SR_CONF_VOLTAGE_TARGET:
254                         *data = g_variant_new_double(
255                                 devc->config[channel].output_voltage_max);
256                         break;
257                 case SR_CONF_CURRENT:
258                         *data = g_variant_new_double(
259                                 devc->config[channel].output_current_last);
260                         break;
261                 case SR_CONF_CURRENT_LIMIT:
262                         *data = g_variant_new_double(
263                                 devc->config[channel].output_current_max);
264                         break;
265                 default:
266                         return SR_ERR_NA;
267                 }
268         }
269
270         return ret;
271 }
272
273 static int config_set(uint32_t key, GVariant *data,
274         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
275 {
276         int ret, channel;
277         const struct sr_channel *ch;
278         double dval;
279         gboolean bval;
280         struct dev_context *devc;
281
282         devc = sdi->priv;
283
284         ret = SR_OK;
285
286         switch (key) {
287         case SR_CONF_LIMIT_MSEC:
288         case SR_CONF_LIMIT_SAMPLES:
289                 return sr_sw_limits_config_set(&devc->limits, key, data);
290         case SR_CONF_ENABLED:
291                 bval = g_variant_get_boolean(data);
292                 gpd_send_cmd(sdi->conn, "OUT%c\n", bval ? '1' : '0');
293                 devc->output_enabled = bval;
294                 break;
295         case SR_CONF_VOLTAGE_TARGET:
296                 ch = cg->channels->data;
297                 channel = ch->index;
298                 dval = g_variant_get_double(data);
299                 if (dval < devc->model->channels[channel].voltage[0]
300                     || dval > devc->model->channels[channel].voltage[1])
301                         return SR_ERR_ARG;
302                 gpd_send_cmd(sdi->conn, "VSET%d:%05.3lf\n", channel + 1, dval);
303                 devc->config[channel].output_voltage_max = dval;
304                 break;
305         case SR_CONF_CURRENT_LIMIT:
306                 ch = cg->channels->data;
307                 channel = ch->index;
308                 dval = g_variant_get_double(data);
309                 if (dval < devc->model->channels[channel].current[0]
310                     || dval > devc->model->channels[channel].current[1])
311                         return SR_ERR_ARG;
312                 gpd_send_cmd(sdi->conn, "ISET%d:%05.3lf\n", channel + 1, dval);
313                 devc->config[channel].output_current_max = dval;
314                 break;
315         default:
316                 ret = SR_ERR_NA;
317                 break;
318         }
319
320         return ret;
321 }
322
323 static int config_list(uint32_t key, GVariant **data,
324         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
325 {
326         const struct dev_context *devc;
327         const struct sr_channel *ch;
328         int channel;
329
330         devc = (sdi) ? sdi->priv : NULL;
331
332         if (!cg) {
333                 switch (key) {
334                 case SR_CONF_SCAN_OPTIONS:
335                 case SR_CONF_DEVICE_OPTIONS:
336                         return STD_CONFIG_LIST(key, data, sdi, cg, scanopts,
337                                                drvopts, devopts);
338                 case SR_CONF_CHANNEL_CONFIG:
339                         *data = g_variant_new_strv(ARRAY_AND_SIZE(channel_modes));
340                         break;
341                 default:
342                         return SR_ERR_NA;
343                 }
344         } else {
345                 ch = cg->channels->data;
346                 channel = ch->index;
347
348                 switch (key) {
349                 case SR_CONF_DEVICE_OPTIONS:
350                         *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg));
351                         break;
352                 case SR_CONF_VOLTAGE_TARGET:
353                         *data = std_gvar_min_max_step_array(
354                                 devc->model->channels[channel].voltage);
355                         break;
356                 case SR_CONF_CURRENT_LIMIT:
357                         *data = std_gvar_min_max_step_array(
358                                 devc->model->channels[channel].current);
359                         break;
360                 default:
361                         return SR_ERR_NA;
362                 }
363         }
364
365         return SR_OK;
366 }
367
368 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
369 {
370         struct dev_context *devc;
371         struct sr_serial_dev_inst *serial;
372
373         devc = sdi->priv;
374
375         sr_sw_limits_acquisition_start(&devc->limits);
376         std_session_send_df_header(sdi);
377
378         devc->reply_pending = FALSE;
379         devc->req_sent_at = 0;
380         serial = sdi->conn;
381         serial_source_add(sdi->session, serial, G_IO_IN, 100,
382                           gpd_receive_data, (void *)sdi);
383
384         return SR_OK;
385 }
386
387 static struct sr_dev_driver gwinstek_gpd_driver_info = {
388         .name = "gwinstek-gpd",
389         .longname = "GW Instek GPD",
390         .api_version = 1,
391         .init = std_init,
392         .cleanup = std_cleanup,
393         .scan = scan,
394         .dev_list = std_dev_list,
395         .dev_clear = std_dev_clear,
396         .config_get = config_get,
397         .config_set = config_set,
398         .config_list = config_list,
399         .dev_open = std_serial_dev_open,
400         .dev_close = std_serial_dev_close,
401         .dev_acquisition_start = dev_acquisition_start,
402         .dev_acquisition_stop = std_serial_dev_acquisition_stop,
403         .context = NULL,
404 };
405 SR_REGISTER_DEV_DRIVER(gwinstek_gpd_driver_info);