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