]> sigrok.org Git - libsigrok.git/blame - src/hardware/korad-kaxxxxp/api.c
Consistently use the "Sysclk" spelling everywhere.
[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}},
9e9dba7b 75 ALL_ZERO
d7083042
HV
76};
77
e75ee7de
HV
78static GSList *scan(struct sr_dev_driver *di, GSList *options)
79{
d7083042 80 struct dev_context *devc;
43376f33 81 GSList *l;
d7083042
HV
82 struct sr_dev_inst *sdi;
83 struct sr_config *src;
84 const char *conn, *serialcomm;
85 struct sr_serial_dev_inst *serial;
86 char reply[50];
87 int i, model_id;
88 unsigned int len;
e75ee7de 89
d7083042
HV
90 conn = NULL;
91 serialcomm = NULL;
e75ee7de 92
d7083042
HV
93 for (l = options; l; l = l->next) {
94 src = l->data;
95 switch (src->key) {
96 case SR_CONF_CONN:
97 conn = g_variant_get_string(src->data, NULL);
98 break;
99 case SR_CONF_SERIALCOMM:
100 serialcomm = g_variant_get_string(src->data, NULL);
101 break;
102 default:
103 sr_err("Unknown option %d, skipping.", src->key);
104 break;
105 }
106 }
107
108 if (!conn)
109 return NULL;
110 if (!serialcomm)
111 serialcomm = "9600/8n1";
112
113 serial = sr_serial_dev_inst_new(conn, serialcomm);
114 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
115 return NULL;
116
117 serial_flush(serial);
118
119 /* Get the device model. */
120 len = 0;
121 for (i = 0; models[i].id; i++) {
122 if (strlen(models[i].id) > len)
123 len = strlen(models[i].id);
124 }
125 memset(&reply, 0, sizeof(reply));
126 sr_dbg("Want max %d bytes.", len);
16fc7ee2 127 if ((korad_kaxxxxp_send_cmd(serial, "*IDN?") < 0))
d7083042
HV
128 return NULL;
129
130 /* i is used here for debug purposes only. */
16fc7ee2 131 if ((i = korad_kaxxxxp_read_chars(serial, len, reply)) < 0)
d7083042
HV
132 return NULL;
133 sr_dbg("Received: %d, %s", i, reply);
134 model_id = -1;
135 for (i = 0; models[i].id; i++) {
1c0e1baa 136 if (!g_strcmp0(models[i].id, reply))
d7083042
HV
137 model_id = i;
138 }
139 if (model_id < 0) {
140 sr_err("Unknown model ID '%s' detected, aborting.", reply);
141 return NULL;
142 }
a078d3ec
UH
143 sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor,
144 models[model_id].name, model_id, models[model_id].id);
d7083042 145
d7083042
HV
146 sdi = g_malloc0(sizeof(struct sr_dev_inst));
147 sdi->status = SR_ST_INACTIVE;
148 sdi->vendor = g_strdup(models[model_id].vendor);
149 sdi->model = g_strdup(models[model_id].name);
150 sdi->inst_type = SR_INST_SERIAL;
151 sdi->conn = serial;
d7083042 152
23165d7b
FS
153 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
154 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
d7083042
HV
155
156 devc = g_malloc0(sizeof(struct dev_context));
597deef9 157 sr_sw_limits_init(&devc->limits);
3f9b48ae 158 g_mutex_init(&devc->rw_mutex);
d7083042 159 devc->model = &models[model_id];
d7083042
HV
160 devc->req_sent_at = 0;
161 sdi->priv = devc;
162
163 /* Get current status of device. */
16fc7ee2 164 if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
d7083042 165 goto exit_err;
d7083042
HV
166
167 serial_close(serial);
e75ee7de 168
43376f33 169 return std_scan_complete(di, g_slist_append(NULL, sdi));
d7083042
HV
170
171exit_err:
172 sr_dev_inst_free(sdi);
173 g_free(devc);
174 sr_dbg("Scan failed.");
175
176 return NULL;
e75ee7de
HV
177}
178
e75ee7de
HV
179static int config_get(uint32_t key, GVariant **data,
180 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
181{
d7083042 182 struct dev_context *devc;
e75ee7de 183
e75ee7de
HV
184 (void)cg;
185
d7083042
HV
186 if (!sdi || !data)
187 return SR_ERR_ARG;
188
189 devc = sdi->priv;
190
e75ee7de 191 switch (key) {
cd04f641
UH
192 case SR_CONF_LIMIT_SAMPLES:
193 case SR_CONF_LIMIT_MSEC:
597deef9 194 return sr_sw_limits_config_get(&devc->limits, key, data);
d7083042 195 case SR_CONF_VOLTAGE:
3f9b48ae 196 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
d7083042
HV
197 *data = g_variant_new_double(devc->voltage);
198 break;
199 case SR_CONF_VOLTAGE_TARGET:
3f9b48ae 200 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_MAX, devc);
d7083042
HV
201 *data = g_variant_new_double(devc->voltage_max);
202 break;
203 case SR_CONF_CURRENT:
3f9b48ae 204 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
d7083042
HV
205 *data = g_variant_new_double(devc->current);
206 break;
207 case SR_CONF_CURRENT_LIMIT:
3f9b48ae 208 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_MAX, devc);
d7083042
HV
209 *data = g_variant_new_double(devc->current_max);
210 break;
211 case SR_CONF_ENABLED:
3f9b48ae 212 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
d7083042
HV
213 *data = g_variant_new_boolean(devc->output_enabled);
214 break;
b16d975a
HV
215 case SR_CONF_REGULATION:
216 /* Dual channel not supported. */
3f9b48ae 217 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
9e5366df 218 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
b16d975a 219 break;
c40ed60f 220 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
3f9b48ae 221 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
9e5366df 222 *data = g_variant_new_boolean(devc->ocp_enabled);
c40ed60f
HV
223 break;
224 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
3f9b48ae 225 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
9e5366df 226 *data = g_variant_new_boolean(devc->ovp_enabled);
c40ed60f 227 break;
e75ee7de
HV
228 default:
229 return SR_ERR_NA;
230 }
231
d7083042 232 return SR_OK;
e75ee7de
HV
233}
234
235static int config_set(uint32_t key, GVariant *data,
236 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
237{
d7083042
HV
238 struct dev_context *devc;
239 double dval;
240 gboolean bval;
e75ee7de 241
e75ee7de
HV
242 (void)cg;
243
d7083042
HV
244 devc = sdi->priv;
245
e75ee7de 246 switch (key) {
d7083042 247 case SR_CONF_LIMIT_MSEC:
d7083042 248 case SR_CONF_LIMIT_SAMPLES:
597deef9 249 return sr_sw_limits_config_set(&devc->limits, key, data);
d7083042
HV
250 case SR_CONF_VOLTAGE_TARGET:
251 dval = g_variant_get_double(data);
252 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
253 return SR_ERR_ARG;
254 devc->voltage_max = dval;
3f9b48ae 255 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_MAX, devc) < 0)
d7083042
HV
256 return SR_ERR;
257 break;
258 case SR_CONF_CURRENT_LIMIT:
259 dval = g_variant_get_double(data);
260 if (dval < devc->model->current[0] || dval > devc->model->current[1])
261 return SR_ERR_ARG;
262 devc->current_max = dval;
3f9b48ae 263 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_MAX, devc) < 0)
d7083042
HV
264 return SR_ERR;
265 break;
266 case SR_CONF_ENABLED:
267 bval = g_variant_get_boolean(data);
268 /* Set always so it is possible turn off with sigrok-cli. */
269 devc->output_enabled = bval;
3f9b48ae 270 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
d7083042 271 return SR_ERR;
c40ed60f
HV
272 break;
273 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
274 bval = g_variant_get_boolean(data);
9e5366df 275 devc->ocp_enabled = bval;
3f9b48ae 276 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
c40ed60f
HV
277 return SR_ERR;
278 break;
279 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
280 bval = g_variant_get_boolean(data);
9e5366df 281 devc->ovp_enabled = bval;
3f9b48ae 282 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
c40ed60f 283 return SR_ERR;
d7083042 284 break;
e75ee7de 285 default:
d7083042 286 return SR_ERR_NA;
e75ee7de
HV
287 }
288
d7083042 289 return SR_OK;
e75ee7de
HV
290}
291
292static int config_list(uint32_t key, GVariant **data,
293 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
294{
d7083042 295 struct dev_context *devc;
d7083042 296
e66d1892 297 devc = (sdi) ? sdi->priv : NULL;
d7083042 298
e75ee7de 299 switch (key) {
e66d1892 300 case SR_CONF_SCAN_OPTIONS:
d7083042 301 case SR_CONF_DEVICE_OPTIONS:
e66d1892 302 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
d7083042 303 case SR_CONF_VOLTAGE_TARGET:
fc69eecc
GS
304 if (!devc || !devc->model)
305 return SR_ERR_ARG;
54d471f4 306 *data = std_gvar_min_max_step_array(devc->model->voltage);
d7083042
HV
307 break;
308 case SR_CONF_CURRENT_LIMIT:
fc69eecc
GS
309 if (!devc || !devc->model)
310 return SR_ERR_ARG;
54d471f4 311 *data = std_gvar_min_max_step_array(devc->model->current);
d7083042 312 break;
e75ee7de
HV
313 default:
314 return SR_ERR_NA;
315 }
316
d7083042 317 return SR_OK;
e75ee7de
HV
318}
319
3f9b48ae
FS
320static int dev_close(struct sr_dev_inst *sdi)
321{
322 struct dev_context *devc;
323
324 devc = (sdi) ? sdi->priv : NULL;
325 if (devc)
326 g_mutex_clear(&devc->rw_mutex);
327
328 return std_serial_dev_close(sdi);
329}
330
695dc859 331static int dev_acquisition_start(const struct sr_dev_inst *sdi)
e75ee7de 332{
d7083042
HV
333 struct dev_context *devc;
334 struct sr_serial_dev_inst *serial;
e75ee7de 335
d7083042 336 devc = sdi->priv;
d7083042 337
597deef9 338 sr_sw_limits_acquisition_start(&devc->limits);
bee2b016 339 std_session_send_df_header(sdi);
d7083042 340
d7083042
HV
341 devc->req_sent_at = 0;
342 serial = sdi->conn;
343 serial_source_add(sdi->session, serial, G_IO_IN,
16fc7ee2
UH
344 KAXXXXP_POLL_INTERVAL_MS,
345 korad_kaxxxxp_receive_data, (void *)sdi);
e75ee7de
HV
346
347 return SR_OK;
348}
349
dd5c48a6 350static struct sr_dev_driver korad_kaxxxxp_driver_info = {
16fc7ee2
UH
351 .name = "korad-kaxxxxp",
352 .longname = "Korad KAxxxxP",
e75ee7de 353 .api_version = 1,
c2fdcc25 354 .init = std_init,
700d6b64 355 .cleanup = std_cleanup,
e75ee7de 356 .scan = scan,
c01bf34c 357 .dev_list = std_dev_list,
f778bf02 358 .dev_clear = std_dev_clear,
e75ee7de
HV
359 .config_get = config_get,
360 .config_set = config_set,
361 .config_list = config_list,
d7083042 362 .dev_open = std_serial_dev_open,
3f9b48ae 363 .dev_close = dev_close,
e75ee7de 364 .dev_acquisition_start = dev_acquisition_start,
4b1a9d5d 365 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
e75ee7de
HV
366 .context = NULL,
367};
dd5c48a6 368SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);