]> sigrok.org Git - libsigrok.git/blame - src/hardware/korad-kaxxxxp/api.c
korad-kaxxxxp: Fix bug when setting values while acquisition is running.
[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>
3f9b48ae 5 * Copyright (C) 2018 Frank Stettner <frank-stettner@gmx.net>
e75ee7de
HV
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#include <config.h>
22#include "protocol.h"
23
d7083042
HV
24static const uint32_t scanopts[] = {
25 SR_CONF_CONN,
26 SR_CONF_SERIALCOMM,
27};
28
55fb76b3 29static const uint32_t drvopts[] = {
55fb76b3
UH
30 SR_CONF_POWER_SUPPLY,
31};
32
d7083042 33static const uint32_t devopts[] = {
d7083042
HV
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,
d7083042
HV
37 SR_CONF_VOLTAGE | SR_CONF_GET,
38 SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
39 SR_CONF_CURRENT | SR_CONF_GET,
40 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
41 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
b16d975a 42 SR_CONF_REGULATION | SR_CONF_GET,
c40ed60f
HV
43 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
44 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
d7083042
HV
45};
46
16fc7ee2 47static const struct korad_kaxxxxp_model models[] = {
d7083042 48 /* Device enum, vendor, model, ID reply, channels, voltage, current */
ae9ca5b1
UH
49 {VELLEMAN_PS3005D, "Velleman", "PS3005D",
50 "VELLEMANPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
51 {VELLEMAN_LABPS3005D, "Velleman", "LABPS3005D",
d7083042 52 "VELLEMANLABPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
bcf9384d 53 {KORAD_KA3005P, "Korad", "KA3005P",
2c5bdf1b 54 "KORADKA3005PV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
a078d3ec
UH
55 /* Sometimes the KA3005P has an extra 0x01 after the ID. */
56 {KORAD_KA3005P_0X01, "Korad", "KA3005P",
57 "KORADKA3005PV2.0\x01", 1, {0, 31, 0.01}, {0, 5, 0.001}},
1c0e1baa
FS
58 /* Sometimes the KA3005P has an extra 0xBC after the ID. */
59 {KORAD_KA3005P_0XBC, "Korad", "KA3005P",
60 "KORADKA3005PV2.0\xBC", 1, {0, 31, 0.01}, {0, 5, 0.001}},
41802ca4
HM
61 {KORAD_KD3005P, "Korad", "KD3005P",
62 "KORAD KD3005P V2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
76f712a7
GS
63 {KORAD_KD3005P_V20_NOSP, "Korad", "KD3005P",
64 "KORADKD3005PV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
e843992d
AH
65 {RND_320K30PV, "RND", "KA3005P",
66 "RND 320-KA3005P V2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
0540954d
UH
67 {TENMA_72_2540_V20, "Tenma", "72-2540",
68 "TENMA72-2540V2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
69 {TENMA_72_2540_V21, "Tenma", "72-2540",
70 "TENMA 72-2540 V2.1", 1, {0, 31, 0.01}, {0, 5, 0.001}},
ddbe6880
DA
71 {TENMA_72_2535_V21, "Tenma", "72-2535",
72 "TENMA 72-2535 V2.1", 1, {0, 31, 0.01}, {0, 3, 0.001}},
27a9b663
TA
73 {STAMOS_SLS31_V20, "Stamos Soldering", "S-LS-31",
74 "S-LS-31 V2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
b1b8a7d0
EE
75 {KORAD_KD6005P, "Korad", "KD6005P",
76 "KORAD KD6005P V2.2", 1, {0, 61, 0.01}, {0, 5, 0.001}},
9e9dba7b 77 ALL_ZERO
d7083042
HV
78};
79
e75ee7de
HV
80static GSList *scan(struct sr_dev_driver *di, GSList *options)
81{
d7083042 82 struct dev_context *devc;
43376f33 83 GSList *l;
d7083042
HV
84 struct sr_dev_inst *sdi;
85 struct sr_config *src;
86 const char *conn, *serialcomm;
87 struct sr_serial_dev_inst *serial;
88 char reply[50];
89 int i, model_id;
90 unsigned int len;
e75ee7de 91
d7083042
HV
92 conn = NULL;
93 serialcomm = NULL;
e75ee7de 94
d7083042
HV
95 for (l = options; l; l = l->next) {
96 src = l->data;
97 switch (src->key) {
98 case SR_CONF_CONN:
99 conn = g_variant_get_string(src->data, NULL);
100 break;
101 case SR_CONF_SERIALCOMM:
102 serialcomm = g_variant_get_string(src->data, NULL);
103 break;
104 default:
105 sr_err("Unknown option %d, skipping.", src->key);
106 break;
107 }
108 }
109
110 if (!conn)
111 return NULL;
112 if (!serialcomm)
113 serialcomm = "9600/8n1";
114
115 serial = sr_serial_dev_inst_new(conn, serialcomm);
116 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
117 return NULL;
118
119 serial_flush(serial);
120
121 /* Get the device model. */
122 len = 0;
123 for (i = 0; models[i].id; i++) {
124 if (strlen(models[i].id) > len)
125 len = strlen(models[i].id);
126 }
127 memset(&reply, 0, sizeof(reply));
128 sr_dbg("Want max %d bytes.", len);
16fc7ee2 129 if ((korad_kaxxxxp_send_cmd(serial, "*IDN?") < 0))
d7083042
HV
130 return NULL;
131
132 /* i is used here for debug purposes only. */
16fc7ee2 133 if ((i = korad_kaxxxxp_read_chars(serial, len, reply)) < 0)
d7083042
HV
134 return NULL;
135 sr_dbg("Received: %d, %s", i, reply);
136 model_id = -1;
137 for (i = 0; models[i].id; i++) {
1c0e1baa 138 if (!g_strcmp0(models[i].id, reply))
d7083042
HV
139 model_id = i;
140 }
141 if (model_id < 0) {
142 sr_err("Unknown model ID '%s' detected, aborting.", reply);
143 return NULL;
144 }
a078d3ec
UH
145 sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor,
146 models[model_id].name, model_id, models[model_id].id);
d7083042 147
d7083042
HV
148 sdi = g_malloc0(sizeof(struct sr_dev_inst));
149 sdi->status = SR_ST_INACTIVE;
150 sdi->vendor = g_strdup(models[model_id].vendor);
151 sdi->model = g_strdup(models[model_id].name);
152 sdi->inst_type = SR_INST_SERIAL;
153 sdi->conn = serial;
d7083042 154
23165d7b
FS
155 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
156 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
d7083042
HV
157
158 devc = g_malloc0(sizeof(struct dev_context));
597deef9 159 sr_sw_limits_init(&devc->limits);
3f9b48ae 160 g_mutex_init(&devc->rw_mutex);
d7083042 161 devc->model = &models[model_id];
d7083042
HV
162 devc->req_sent_at = 0;
163 sdi->priv = devc;
164
165 /* Get current status of device. */
16fc7ee2 166 if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
d7083042 167 goto exit_err;
d7083042
HV
168
169 serial_close(serial);
e75ee7de 170
43376f33 171 return std_scan_complete(di, g_slist_append(NULL, sdi));
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) {
cd04f641
UH
194 case SR_CONF_LIMIT_SAMPLES:
195 case SR_CONF_LIMIT_MSEC:
597deef9 196 return sr_sw_limits_config_get(&devc->limits, key, data);
d7083042 197 case SR_CONF_VOLTAGE:
3f9b48ae 198 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
d7083042
HV
199 *data = g_variant_new_double(devc->voltage);
200 break;
201 case SR_CONF_VOLTAGE_TARGET:
8da30037
FS
202 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc);
203 *data = g_variant_new_double(devc->voltage_target);
d7083042
HV
204 break;
205 case SR_CONF_CURRENT:
3f9b48ae 206 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
d7083042
HV
207 *data = g_variant_new_double(devc->current);
208 break;
209 case SR_CONF_CURRENT_LIMIT:
8da30037
FS
210 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc);
211 *data = g_variant_new_double(devc->current_limit);
d7083042
HV
212 break;
213 case SR_CONF_ENABLED:
3f9b48ae 214 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
d7083042
HV
215 *data = g_variant_new_boolean(devc->output_enabled);
216 break;
b16d975a
HV
217 case SR_CONF_REGULATION:
218 /* Dual channel not supported. */
3f9b48ae 219 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
9e5366df 220 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
b16d975a 221 break;
c40ed60f 222 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
3f9b48ae 223 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
9e5366df 224 *data = g_variant_new_boolean(devc->ocp_enabled);
c40ed60f
HV
225 break;
226 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
3f9b48ae 227 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
9e5366df 228 *data = g_variant_new_boolean(devc->ovp_enabled);
c40ed60f 229 break;
e75ee7de
HV
230 default:
231 return SR_ERR_NA;
232 }
233
d7083042 234 return SR_OK;
e75ee7de
HV
235}
236
237static int config_set(uint32_t key, GVariant *data,
238 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
239{
d7083042
HV
240 struct dev_context *devc;
241 double dval;
242 gboolean bval;
e75ee7de 243
e75ee7de
HV
244 (void)cg;
245
d7083042
HV
246 devc = sdi->priv;
247
e75ee7de 248 switch (key) {
d7083042 249 case SR_CONF_LIMIT_MSEC:
d7083042 250 case SR_CONF_LIMIT_SAMPLES:
597deef9 251 return sr_sw_limits_config_set(&devc->limits, key, data);
d7083042
HV
252 case SR_CONF_VOLTAGE_TARGET:
253 dval = g_variant_get_double(data);
254 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
255 return SR_ERR_ARG;
8da30037
FS
256 devc->set_voltage_target = dval;
257 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc) < 0)
d7083042
HV
258 return SR_ERR;
259 break;
260 case SR_CONF_CURRENT_LIMIT:
261 dval = g_variant_get_double(data);
262 if (dval < devc->model->current[0] || dval > devc->model->current[1])
263 return SR_ERR_ARG;
8da30037
FS
264 devc->set_current_limit = dval;
265 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc) < 0)
d7083042
HV
266 return SR_ERR;
267 break;
268 case SR_CONF_ENABLED:
269 bval = g_variant_get_boolean(data);
270 /* Set always so it is possible turn off with sigrok-cli. */
8da30037 271 devc->set_output_enabled = bval;
3f9b48ae 272 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
d7083042 273 return SR_ERR;
c40ed60f
HV
274 break;
275 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
276 bval = g_variant_get_boolean(data);
8da30037 277 devc->set_ocp_enabled = bval;
3f9b48ae 278 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
c40ed60f
HV
279 return SR_ERR;
280 break;
281 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
282 bval = g_variant_get_boolean(data);
8da30037 283 devc->set_ovp_enabled = bval;
3f9b48ae 284 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
c40ed60f 285 return SR_ERR;
d7083042 286 break;
e75ee7de 287 default:
d7083042 288 return SR_ERR_NA;
e75ee7de
HV
289 }
290
d7083042 291 return SR_OK;
e75ee7de
HV
292}
293
294static int config_list(uint32_t key, GVariant **data,
295 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
296{
d7083042 297 struct dev_context *devc;
d7083042 298
e66d1892 299 devc = (sdi) ? sdi->priv : NULL;
d7083042 300
e75ee7de 301 switch (key) {
e66d1892 302 case SR_CONF_SCAN_OPTIONS:
d7083042 303 case SR_CONF_DEVICE_OPTIONS:
e66d1892 304 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
d7083042 305 case SR_CONF_VOLTAGE_TARGET:
fc69eecc
GS
306 if (!devc || !devc->model)
307 return SR_ERR_ARG;
54d471f4 308 *data = std_gvar_min_max_step_array(devc->model->voltage);
d7083042
HV
309 break;
310 case SR_CONF_CURRENT_LIMIT:
fc69eecc
GS
311 if (!devc || !devc->model)
312 return SR_ERR_ARG;
54d471f4 313 *data = std_gvar_min_max_step_array(devc->model->current);
d7083042 314 break;
e75ee7de
HV
315 default:
316 return SR_ERR_NA;
317 }
318
d7083042 319 return SR_OK;
e75ee7de
HV
320}
321
3f9b48ae
FS
322static int dev_close(struct sr_dev_inst *sdi)
323{
324 struct dev_context *devc;
325
326 devc = (sdi) ? sdi->priv : NULL;
327 if (devc)
328 g_mutex_clear(&devc->rw_mutex);
329
330 return std_serial_dev_close(sdi);
331}
332
695dc859 333static int dev_acquisition_start(const struct sr_dev_inst *sdi)
e75ee7de 334{
d7083042
HV
335 struct dev_context *devc;
336 struct sr_serial_dev_inst *serial;
e75ee7de 337
d7083042 338 devc = sdi->priv;
d7083042 339
597deef9 340 sr_sw_limits_acquisition_start(&devc->limits);
bee2b016 341 std_session_send_df_header(sdi);
d7083042 342
d7083042
HV
343 devc->req_sent_at = 0;
344 serial = sdi->conn;
345 serial_source_add(sdi->session, serial, G_IO_IN,
16fc7ee2
UH
346 KAXXXXP_POLL_INTERVAL_MS,
347 korad_kaxxxxp_receive_data, (void *)sdi);
e75ee7de
HV
348
349 return SR_OK;
350}
351
dd5c48a6 352static struct sr_dev_driver korad_kaxxxxp_driver_info = {
16fc7ee2
UH
353 .name = "korad-kaxxxxp",
354 .longname = "Korad KAxxxxP",
e75ee7de 355 .api_version = 1,
c2fdcc25 356 .init = std_init,
700d6b64 357 .cleanup = std_cleanup,
e75ee7de 358 .scan = scan,
c01bf34c 359 .dev_list = std_dev_list,
f778bf02 360 .dev_clear = std_dev_clear,
e75ee7de
HV
361 .config_get = config_get,
362 .config_set = config_set,
363 .config_list = config_list,
d7083042 364 .dev_open = std_serial_dev_open,
3f9b48ae 365 .dev_close = dev_close,
e75ee7de 366 .dev_acquisition_start = dev_acquisition_start,
4b1a9d5d 367 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
e75ee7de
HV
368 .context = NULL,
369};
dd5c48a6 370SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);