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