]> sigrok.org Git - libsigrok.git/blame - src/hardware/korad-kaxxxxp/api.c
config_list: Don't check for sdi->priv != NULL.
[libsigrok.git] / src / hardware / korad-kaxxxxp / api.c
CommitLineData
e75ee7de
HV
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2015 Hannu Vuolasaho <vuokkosetae@gmail.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 <config.h>
21#include "protocol.h"
22
d7083042
HV
23static const uint32_t drvopts[] = {
24 /* Device class */
25 SR_CONF_POWER_SUPPLY,
26};
27
28static const uint32_t scanopts[] = {
29 SR_CONF_CONN,
30 SR_CONF_SERIALCOMM,
31};
32
33static const uint32_t devopts[] = {
34 /* Device class */
35 SR_CONF_POWER_SUPPLY,
36 /* Acquisition modes. */
37 SR_CONF_CONTINUOUS,
38 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
39 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
40 /* Device configuration */
41 SR_CONF_VOLTAGE | SR_CONF_GET,
42 SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
43 SR_CONF_CURRENT | SR_CONF_GET,
44 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
45 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
b16d975a 46 SR_CONF_REGULATION | SR_CONF_GET,
c40ed60f
HV
47 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
48 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
d7083042
HV
49};
50
16fc7ee2 51static const struct korad_kaxxxxp_model models[] = {
d7083042 52 /* Device enum, vendor, model, ID reply, channels, voltage, current */
ae9ca5b1
UH
53 {VELLEMAN_PS3005D, "Velleman", "PS3005D",
54 "VELLEMANPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
55 {VELLEMAN_LABPS3005D, "Velleman", "LABPS3005D",
d7083042 56 "VELLEMANLABPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
bcf9384d 57 {KORAD_KA3005P, "Korad", "KA3005P",
2c5bdf1b 58 "KORADKA3005PV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
a078d3ec
UH
59 /* Sometimes the KA3005P has an extra 0x01 after the ID. */
60 {KORAD_KA3005P_0X01, "Korad", "KA3005P",
61 "KORADKA3005PV2.0\x01", 1, {0, 31, 0.01}, {0, 5, 0.001}},
9e9dba7b 62 ALL_ZERO
d7083042
HV
63};
64
16fc7ee2 65SR_PRIV struct sr_dev_driver korad_kaxxxxp_driver_info;
e75ee7de 66
e75ee7de
HV
67static GSList *scan(struct sr_dev_driver *di, GSList *options)
68{
69 struct drv_context *drvc;
d7083042
HV
70 struct dev_context *devc;
71 GSList *devices, *l;
72 struct sr_dev_inst *sdi;
73 struct sr_config *src;
74 const char *conn, *serialcomm;
75 struct sr_serial_dev_inst *serial;
76 char reply[50];
77 int i, model_id;
78 unsigned int len;
e75ee7de
HV
79
80 devices = NULL;
d7083042
HV
81 conn = NULL;
82 serialcomm = NULL;
e75ee7de
HV
83 drvc = di->context;
84 drvc->instances = NULL;
85
d7083042
HV
86 for (l = options; l; l = l->next) {
87 src = l->data;
88 switch (src->key) {
89 case SR_CONF_CONN:
90 conn = g_variant_get_string(src->data, NULL);
91 break;
92 case SR_CONF_SERIALCOMM:
93 serialcomm = g_variant_get_string(src->data, NULL);
94 break;
95 default:
96 sr_err("Unknown option %d, skipping.", src->key);
97 break;
98 }
99 }
100
101 if (!conn)
102 return NULL;
103 if (!serialcomm)
104 serialcomm = "9600/8n1";
105
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
112 /* Get the device model. */
113 len = 0;
114 for (i = 0; models[i].id; i++) {
115 if (strlen(models[i].id) > len)
116 len = strlen(models[i].id);
117 }
118 memset(&reply, 0, sizeof(reply));
119 sr_dbg("Want max %d bytes.", len);
16fc7ee2 120 if ((korad_kaxxxxp_send_cmd(serial, "*IDN?") < 0))
d7083042
HV
121 return NULL;
122
123 /* i is used here for debug purposes only. */
16fc7ee2 124 if ((i = korad_kaxxxxp_read_chars(serial, len, reply)) < 0)
d7083042
HV
125 return NULL;
126 sr_dbg("Received: %d, %s", i, reply);
127 model_id = -1;
128 for (i = 0; models[i].id; i++) {
129 if (!strcmp(models[i].id, reply))
130 model_id = i;
131 }
132 if (model_id < 0) {
133 sr_err("Unknown model ID '%s' detected, aborting.", reply);
134 return NULL;
135 }
a078d3ec
UH
136 sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor,
137 models[model_id].name, model_id, models[model_id].id);
d7083042
HV
138
139 /* Init device instance, etc. */
140 sdi = g_malloc0(sizeof(struct sr_dev_inst));
141 sdi->status = SR_ST_INACTIVE;
142 sdi->vendor = g_strdup(models[model_id].vendor);
143 sdi->model = g_strdup(models[model_id].name);
144 sdi->inst_type = SR_INST_SERIAL;
145 sdi->conn = serial;
146 sdi->driver = di;
147
148 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
149
150 devc = g_malloc0(sizeof(struct dev_context));
597deef9 151 sr_sw_limits_init(&devc->limits);
d7083042
HV
152 devc->model = &models[model_id];
153 devc->reply[5] = 0;
154 devc->req_sent_at = 0;
155 sdi->priv = devc;
156
157 /* Get current status of device. */
16fc7ee2 158 if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
d7083042
HV
159 goto exit_err;
160 drvc->instances = g_slist_append(drvc->instances, sdi);
161 devices = g_slist_append(devices, sdi);
162
163 serial_close(serial);
164 if (!devices)
165 sr_serial_dev_inst_free(serial);
e75ee7de
HV
166
167 return devices;
d7083042
HV
168
169exit_err:
170 sr_dev_inst_free(sdi);
171 g_free(devc);
172 sr_dbg("Scan failed.");
173
174 return NULL;
e75ee7de
HV
175}
176
e75ee7de
HV
177static int config_get(uint32_t key, GVariant **data,
178 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
179{
d7083042 180 struct dev_context *devc;
e75ee7de 181
e75ee7de
HV
182 (void)cg;
183
d7083042
HV
184 if (!sdi || !data)
185 return SR_ERR_ARG;
186
187 devc = sdi->priv;
188
e75ee7de 189 switch (key) {
597deef9 190 return sr_sw_limits_config_get(&devc->limits, key, data);
d7083042
HV
191 case SR_CONF_VOLTAGE:
192 *data = g_variant_new_double(devc->voltage);
193 break;
194 case SR_CONF_VOLTAGE_TARGET:
195 *data = g_variant_new_double(devc->voltage_max);
196 break;
197 case SR_CONF_CURRENT:
198 *data = g_variant_new_double(devc->current);
199 break;
200 case SR_CONF_CURRENT_LIMIT:
201 *data = g_variant_new_double(devc->current_max);
202 break;
203 case SR_CONF_ENABLED:
204 *data = g_variant_new_boolean(devc->output_enabled);
205 break;
b16d975a
HV
206 case SR_CONF_REGULATION:
207 /* Dual channel not supported. */
9e5366df 208 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
b16d975a 209 break;
c40ed60f 210 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
9e5366df 211 *data = g_variant_new_boolean(devc->ocp_enabled);
c40ed60f
HV
212 break;
213 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
9e5366df 214 *data = g_variant_new_boolean(devc->ovp_enabled);
c40ed60f 215 break;
e75ee7de
HV
216 default:
217 return SR_ERR_NA;
218 }
219
d7083042 220 return SR_OK;
e75ee7de
HV
221}
222
223static int config_set(uint32_t key, GVariant *data,
224 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
225{
d7083042
HV
226 struct dev_context *devc;
227 double dval;
228 gboolean bval;
e75ee7de 229
e75ee7de
HV
230 (void)cg;
231
232 if (sdi->status != SR_ST_ACTIVE)
233 return SR_ERR_DEV_CLOSED;
234
d7083042
HV
235 devc = sdi->priv;
236
e75ee7de 237 switch (key) {
d7083042 238 case SR_CONF_LIMIT_MSEC:
d7083042 239 case SR_CONF_LIMIT_SAMPLES:
597deef9 240 return sr_sw_limits_config_set(&devc->limits, key, data);
d7083042
HV
241 case SR_CONF_VOLTAGE_TARGET:
242 dval = g_variant_get_double(data);
243 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
244 return SR_ERR_ARG;
245 devc->voltage_max = dval;
16fc7ee2
UH
246 devc->target = KAXXXXP_VOLTAGE_MAX;
247 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
d7083042
HV
248 return SR_ERR;
249 break;
250 case SR_CONF_CURRENT_LIMIT:
251 dval = g_variant_get_double(data);
252 if (dval < devc->model->current[0] || dval > devc->model->current[1])
253 return SR_ERR_ARG;
254 devc->current_max = dval;
16fc7ee2
UH
255 devc->target = KAXXXXP_CURRENT_MAX;
256 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
d7083042
HV
257 return SR_ERR;
258 break;
259 case SR_CONF_ENABLED:
260 bval = g_variant_get_boolean(data);
261 /* Set always so it is possible turn off with sigrok-cli. */
262 devc->output_enabled = bval;
16fc7ee2
UH
263 devc->target = KAXXXXP_OUTPUT;
264 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
d7083042 265 return SR_ERR;
c40ed60f
HV
266 break;
267 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
268 bval = g_variant_get_boolean(data);
9e5366df 269 devc->ocp_enabled = bval;
16fc7ee2
UH
270 devc->target = KAXXXXP_OCP;
271 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
c40ed60f
HV
272 return SR_ERR;
273 break;
274 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
275 bval = g_variant_get_boolean(data);
9e5366df 276 devc->ovp_enabled = bval;
16fc7ee2
UH
277 devc->target = KAXXXXP_OVP;
278 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
c40ed60f 279 return SR_ERR;
d7083042 280 break;
e75ee7de 281 default:
d7083042 282 return SR_ERR_NA;
e75ee7de
HV
283 }
284
d7083042 285 return SR_OK;
e75ee7de
HV
286}
287
288static int config_list(uint32_t key, GVariant **data,
289 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
290{
d7083042
HV
291 struct dev_context *devc;
292 GVariant *gvar;
293 GVariantBuilder gvb;
294 double dval;
295 int idx;
296
e75ee7de
HV
297 (void)cg;
298
d7083042
HV
299 /* Always available (with or without sdi). */
300 if (key == SR_CONF_SCAN_OPTIONS) {
301 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
302 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
303 return SR_OK;
304 }
305
306 /* Return drvopts without sdi (and devopts with sdi, see below). */
307 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
308 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
309 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
310 return SR_OK;
311 }
312
313 /* Every other key needs an sdi. */
314 if (!sdi)
315 return SR_ERR_ARG;
316
317 devc = sdi->priv;
318
e75ee7de 319 switch (key) {
d7083042
HV
320 case SR_CONF_DEVICE_OPTIONS:
321 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
322 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
323 break;
324 case SR_CONF_VOLTAGE_TARGET:
325 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
326 /* Min, max, step. */
327 for (idx = 0; idx < 3; idx++) {
328 dval = devc->model->voltage[idx];
329 gvar = g_variant_new_double(dval);
330 g_variant_builder_add_value(&gvb, gvar);
331 }
332 *data = g_variant_builder_end(&gvb);
333 break;
334 case SR_CONF_CURRENT_LIMIT:
335 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
336 /* Min, max, step. */
337 for (idx = 0; idx < 3; idx++) {
338 dval = devc->model->current[idx];
339 gvar = g_variant_new_double(dval);
340 g_variant_builder_add_value(&gvb, gvar);
341 }
342 *data = g_variant_builder_end(&gvb);
343 break;
e75ee7de
HV
344 default:
345 return SR_ERR_NA;
346 }
347
d7083042 348 return SR_OK;
e75ee7de
HV
349}
350
695dc859 351static int dev_acquisition_start(const struct sr_dev_inst *sdi)
e75ee7de 352{
d7083042
HV
353 struct dev_context *devc;
354 struct sr_serial_dev_inst *serial;
e75ee7de
HV
355
356 if (sdi->status != SR_ST_ACTIVE)
357 return SR_ERR_DEV_CLOSED;
358
d7083042 359 devc = sdi->priv;
d7083042 360
597deef9 361 sr_sw_limits_acquisition_start(&devc->limits);
695dc859 362 std_session_send_df_header(sdi, LOG_PREFIX);
d7083042 363
d7083042
HV
364 devc->reply_pending = FALSE;
365 devc->req_sent_at = 0;
366 serial = sdi->conn;
367 serial_source_add(sdi->session, serial, G_IO_IN,
16fc7ee2
UH
368 KAXXXXP_POLL_INTERVAL_MS,
369 korad_kaxxxxp_receive_data, (void *)sdi);
e75ee7de
HV
370
371 return SR_OK;
372}
373
695dc859 374static int dev_acquisition_stop(struct sr_dev_inst *sdi)
e75ee7de 375{
e75ee7de
HV
376 if (sdi->status != SR_ST_ACTIVE)
377 return SR_ERR_DEV_CLOSED;
378
6525d819 379 return std_serial_dev_acquisition_stop(sdi,
d7083042 380 std_serial_dev_close, sdi->conn, LOG_PREFIX);
e75ee7de
HV
381}
382
16fc7ee2
UH
383SR_PRIV struct sr_dev_driver korad_kaxxxxp_driver_info = {
384 .name = "korad-kaxxxxp",
385 .longname = "Korad KAxxxxP",
e75ee7de 386 .api_version = 1,
c2fdcc25 387 .init = std_init,
700d6b64 388 .cleanup = std_cleanup,
e75ee7de 389 .scan = scan,
c01bf34c 390 .dev_list = std_dev_list,
e75ee7de
HV
391 .config_get = config_get,
392 .config_set = config_set,
393 .config_list = config_list,
d7083042
HV
394 .dev_open = std_serial_dev_open,
395 .dev_close = std_serial_dev_close,
e75ee7de
HV
396 .dev_acquisition_start = dev_acquisition_start,
397 .dev_acquisition_stop = dev_acquisition_stop,
398 .context = NULL,
399};