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