]> sigrok.org Git - libsigrok.git/blame - src/hardware/korad-kaxxxxp/api.c
hwdriver: introduce SR_CONF_FORCE_DETECT config key (scan option)
[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>
2e129b8b 5 * Copyright (C) 2018-2019 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[] = {
048250d0 34 SR_CONF_CONN | SR_CONF_GET,
d7083042
HV
35 SR_CONF_CONTINUOUS,
36 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
37 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
d7083042
HV
38 SR_CONF_VOLTAGE | SR_CONF_GET,
39 SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
40 SR_CONF_CURRENT | SR_CONF_GET,
41 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
42 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
b16d975a 43 SR_CONF_REGULATION | SR_CONF_GET,
c40ed60f
HV
44 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
45 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
d7083042
HV
46};
47
16fc7ee2 48static const struct korad_kaxxxxp_model models[] = {
d7083042 49 /* Device enum, vendor, model, ID reply, channels, voltage, current */
ae9ca5b1 50 {VELLEMAN_PS3005D, "Velleman", "PS3005D",
f5c863e5 51 "VELLEMANPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
ae9ca5b1 52 {VELLEMAN_LABPS3005D, "Velleman", "LABPS3005D",
f5c863e5 53 "VELLEMANLABPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
bcf9384d 54 {KORAD_KA3005P, "Korad", "KA3005P",
f5c863e5 55 "KORADKA3005PV2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
a078d3ec
UH
56 /* Sometimes the KA3005P has an extra 0x01 after the ID. */
57 {KORAD_KA3005P_0X01, "Korad", "KA3005P",
f5c863e5 58 "KORADKA3005PV2.0\x01", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
1c0e1baa
FS
59 /* Sometimes the KA3005P has an extra 0xBC after the ID. */
60 {KORAD_KA3005P_0XBC, "Korad", "KA3005P",
f5c863e5 61 "KORADKA3005PV2.0\xBC", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
7415217e
DSM
62 {KORAD_KA3005P_V42, "Korad", "KA3005P",
63 "KORAD KA3005P V4.2", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
8b58a519
WG
64 {KORAD_KA3005P_V55, "Korad", "KA3005P",
65 "KORAD KA3005P V5.5", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
41802ca4 66 {KORAD_KD3005P, "Korad", "KD3005P",
f5c863e5 67 "KORAD KD3005P V2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
76f712a7 68 {KORAD_KD3005P_V20_NOSP, "Korad", "KD3005P",
f5c863e5 69 "KORADKD3005PV2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
cf6beeb2 70 {RND_320_KD3005P, "RND", "KD3005P",
f5c863e5 71 "RND 320-KD3005P V4.2", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
c8dcd3ab
CF
72 {RND_320_KA3005P, "RND", "KA3005P",
73 "RND 320-KA3005P V5.5", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
e843992d 74 {RND_320K30PV, "RND", "KA3005P",
f5c863e5 75 "RND 320-KA3005P V2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
f5083435 76 {TENMA_72_2550_V2, "Tenma", "72-2550",
77 "TENMA72-2550V2.0", 1, {0, 61, 0.01}, {0, 3.1, 0.001}},
0540954d 78 {TENMA_72_2540_V20, "Tenma", "72-2540",
f5c863e5 79 "TENMA72-2540V2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
0540954d 80 {TENMA_72_2540_V21, "Tenma", "72-2540",
f5c863e5 81 "TENMA 72-2540 V2.1", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
082ca8d8
PP
82 {TENMA_72_2540_V52, "Tenma", "72-2540",
83 "TENMA 72-2540 V5.2", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
ddbe6880 84 {TENMA_72_2535_V21, "Tenma", "72-2535",
f5c863e5 85 "TENMA 72-2535 V2.1", 1, {0, 31, 0.01}, {0, 3.1, 0.001}},
27a9b663
TA
86 {STAMOS_SLS31_V20, "Stamos Soldering", "S-LS-31",
87 "S-LS-31 V2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
b1b8a7d0 88 {KORAD_KD6005P, "Korad", "KD6005P",
f5c863e5 89 "KORAD KD6005P V2.2", 1, {0, 61, 0.01}, {0, 5.1, 0.001}},
9e9dba7b 90 ALL_ZERO
d7083042
HV
91};
92
e75ee7de
HV
93static GSList *scan(struct sr_dev_driver *di, GSList *options)
94{
d7083042 95 struct dev_context *devc;
43376f33 96 GSList *l;
d7083042
HV
97 struct sr_dev_inst *sdi;
98 struct sr_config *src;
99 const char *conn, *serialcomm;
100 struct sr_serial_dev_inst *serial;
101 char reply[50];
102 int i, model_id;
103 unsigned int len;
e75ee7de 104
d7083042
HV
105 conn = NULL;
106 serialcomm = NULL;
e75ee7de 107
d7083042
HV
108 for (l = options; l; l = l->next) {
109 src = l->data;
110 switch (src->key) {
111 case SR_CONF_CONN:
112 conn = g_variant_get_string(src->data, NULL);
113 break;
114 case SR_CONF_SERIALCOMM:
115 serialcomm = g_variant_get_string(src->data, NULL);
116 break;
117 default:
118 sr_err("Unknown option %d, skipping.", src->key);
119 break;
120 }
121 }
122
123 if (!conn)
124 return NULL;
125 if (!serialcomm)
126 serialcomm = "9600/8n1";
127
128 serial = sr_serial_dev_inst_new(conn, serialcomm);
129 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
130 return NULL;
131
d7083042
HV
132 /* Get the device model. */
133 len = 0;
134 for (i = 0; models[i].id; i++) {
135 if (strlen(models[i].id) > len)
136 len = strlen(models[i].id);
137 }
cf6beeb2
138
139 /*
140 * Some models also include the serial number:
141 * RND 320-KD3005P V4.2 SN:59834414
142 */
143 len += 12;
144
d7083042
HV
145 memset(&reply, 0, sizeof(reply));
146 sr_dbg("Want max %d bytes.", len);
16fc7ee2 147 if ((korad_kaxxxxp_send_cmd(serial, "*IDN?") < 0))
d7083042
HV
148 return NULL;
149
150 /* i is used here for debug purposes only. */
16fc7ee2 151 if ((i = korad_kaxxxxp_read_chars(serial, len, reply)) < 0)
d7083042
HV
152 return NULL;
153 sr_dbg("Received: %d, %s", i, reply);
154 model_id = -1;
cf6beeb2
155
156 /* Truncate before serial number. */
157 char *sn = g_strrstr(reply, " SN:");
158 if (sn)
159 *sn = '\0';
160
d7083042 161 for (i = 0; models[i].id; i++) {
1c0e1baa 162 if (!g_strcmp0(models[i].id, reply))
d7083042
HV
163 model_id = i;
164 }
165 if (model_id < 0) {
166 sr_err("Unknown model ID '%s' detected, aborting.", reply);
167 return NULL;
168 }
a078d3ec
UH
169 sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor,
170 models[model_id].name, model_id, models[model_id].id);
d7083042 171
d7083042
HV
172 sdi = g_malloc0(sizeof(struct sr_dev_inst));
173 sdi->status = SR_ST_INACTIVE;
174 sdi->vendor = g_strdup(models[model_id].vendor);
175 sdi->model = g_strdup(models[model_id].name);
176 sdi->inst_type = SR_INST_SERIAL;
177 sdi->conn = serial;
048250d0 178 sdi->connection_id = g_strdup(conn);
d7083042 179
23165d7b
FS
180 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
181 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
d7083042
HV
182
183 devc = g_malloc0(sizeof(struct dev_context));
597deef9 184 sr_sw_limits_init(&devc->limits);
3f9b48ae 185 g_mutex_init(&devc->rw_mutex);
d7083042 186 devc->model = &models[model_id];
d7083042 187 devc->req_sent_at = 0;
2e129b8b
FS
188 devc->cc_mode_1_changed = FALSE;
189 devc->cc_mode_2_changed = FALSE;
190 devc->output_enabled_changed = FALSE;
191 devc->ocp_enabled_changed = FALSE;
192 devc->ovp_enabled_changed = FALSE;
d7083042
HV
193 sdi->priv = devc;
194
195 /* Get current status of device. */
16fc7ee2 196 if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
d7083042 197 goto exit_err;
d7083042
HV
198
199 serial_close(serial);
e75ee7de 200
43376f33 201 return std_scan_complete(di, g_slist_append(NULL, sdi));
d7083042
HV
202
203exit_err:
204 sr_dev_inst_free(sdi);
205 g_free(devc);
206 sr_dbg("Scan failed.");
207
208 return NULL;
e75ee7de
HV
209}
210
e75ee7de
HV
211static int config_get(uint32_t key, GVariant **data,
212 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
213{
d7083042 214 struct dev_context *devc;
e75ee7de 215
e75ee7de
HV
216 (void)cg;
217
d7083042
HV
218 if (!sdi || !data)
219 return SR_ERR_ARG;
220
221 devc = sdi->priv;
222
e75ee7de 223 switch (key) {
cd04f641
UH
224 case SR_CONF_LIMIT_SAMPLES:
225 case SR_CONF_LIMIT_MSEC:
597deef9 226 return sr_sw_limits_config_get(&devc->limits, key, data);
048250d0
GS
227 case SR_CONF_CONN:
228 *data = g_variant_new_string(sdi->connection_id);
229 break;
d7083042 230 case SR_CONF_VOLTAGE:
3f9b48ae 231 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
d7083042
HV
232 *data = g_variant_new_double(devc->voltage);
233 break;
234 case SR_CONF_VOLTAGE_TARGET:
8da30037
FS
235 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc);
236 *data = g_variant_new_double(devc->voltage_target);
d7083042
HV
237 break;
238 case SR_CONF_CURRENT:
3f9b48ae 239 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
d7083042
HV
240 *data = g_variant_new_double(devc->current);
241 break;
242 case SR_CONF_CURRENT_LIMIT:
8da30037
FS
243 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc);
244 *data = g_variant_new_double(devc->current_limit);
d7083042
HV
245 break;
246 case SR_CONF_ENABLED:
3f9b48ae 247 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
d7083042
HV
248 *data = g_variant_new_boolean(devc->output_enabled);
249 break;
b16d975a
HV
250 case SR_CONF_REGULATION:
251 /* Dual channel not supported. */
3f9b48ae 252 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
9e5366df 253 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
b16d975a 254 break;
c40ed60f 255 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
3f9b48ae 256 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
9e5366df 257 *data = g_variant_new_boolean(devc->ocp_enabled);
c40ed60f
HV
258 break;
259 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
3f9b48ae 260 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
9e5366df 261 *data = g_variant_new_boolean(devc->ovp_enabled);
c40ed60f 262 break;
e75ee7de
HV
263 default:
264 return SR_ERR_NA;
265 }
266
d7083042 267 return SR_OK;
e75ee7de
HV
268}
269
270static int config_set(uint32_t key, GVariant *data,
271 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
272{
d7083042
HV
273 struct dev_context *devc;
274 double dval;
275 gboolean bval;
e75ee7de 276
e75ee7de
HV
277 (void)cg;
278
d7083042
HV
279 devc = sdi->priv;
280
e75ee7de 281 switch (key) {
d7083042 282 case SR_CONF_LIMIT_MSEC:
d7083042 283 case SR_CONF_LIMIT_SAMPLES:
597deef9 284 return sr_sw_limits_config_set(&devc->limits, key, data);
d7083042
HV
285 case SR_CONF_VOLTAGE_TARGET:
286 dval = g_variant_get_double(data);
287 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
288 return SR_ERR_ARG;
8da30037
FS
289 devc->set_voltage_target = dval;
290 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc) < 0)
d7083042
HV
291 return SR_ERR;
292 break;
293 case SR_CONF_CURRENT_LIMIT:
294 dval = g_variant_get_double(data);
295 if (dval < devc->model->current[0] || dval > devc->model->current[1])
296 return SR_ERR_ARG;
8da30037
FS
297 devc->set_current_limit = dval;
298 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc) < 0)
d7083042
HV
299 return SR_ERR;
300 break;
301 case SR_CONF_ENABLED:
302 bval = g_variant_get_boolean(data);
303 /* Set always so it is possible turn off with sigrok-cli. */
8da30037 304 devc->set_output_enabled = bval;
3f9b48ae 305 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
d7083042 306 return SR_ERR;
c40ed60f
HV
307 break;
308 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
309 bval = g_variant_get_boolean(data);
8da30037 310 devc->set_ocp_enabled = bval;
3f9b48ae 311 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
c40ed60f
HV
312 return SR_ERR;
313 break;
314 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
315 bval = g_variant_get_boolean(data);
8da30037 316 devc->set_ovp_enabled = bval;
3f9b48ae 317 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
c40ed60f 318 return SR_ERR;
d7083042 319 break;
e75ee7de 320 default:
d7083042 321 return SR_ERR_NA;
e75ee7de
HV
322 }
323
d7083042 324 return SR_OK;
e75ee7de
HV
325}
326
327static int config_list(uint32_t key, GVariant **data,
328 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
329{
d7083042 330 struct dev_context *devc;
d7083042 331
e66d1892 332 devc = (sdi) ? sdi->priv : NULL;
d7083042 333
e75ee7de 334 switch (key) {
e66d1892 335 case SR_CONF_SCAN_OPTIONS:
d7083042 336 case SR_CONF_DEVICE_OPTIONS:
e66d1892 337 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
d7083042 338 case SR_CONF_VOLTAGE_TARGET:
fc69eecc
GS
339 if (!devc || !devc->model)
340 return SR_ERR_ARG;
54d471f4 341 *data = std_gvar_min_max_step_array(devc->model->voltage);
d7083042
HV
342 break;
343 case SR_CONF_CURRENT_LIMIT:
fc69eecc
GS
344 if (!devc || !devc->model)
345 return SR_ERR_ARG;
54d471f4 346 *data = std_gvar_min_max_step_array(devc->model->current);
d7083042 347 break;
e75ee7de
HV
348 default:
349 return SR_ERR_NA;
350 }
351
d7083042 352 return SR_OK;
e75ee7de
HV
353}
354
3f9b48ae
FS
355static int dev_close(struct sr_dev_inst *sdi)
356{
357 struct dev_context *devc;
358
359 devc = (sdi) ? sdi->priv : NULL;
360 if (devc)
361 g_mutex_clear(&devc->rw_mutex);
362
363 return std_serial_dev_close(sdi);
364}
365
695dc859 366static int dev_acquisition_start(const struct sr_dev_inst *sdi)
e75ee7de 367{
d7083042
HV
368 struct dev_context *devc;
369 struct sr_serial_dev_inst *serial;
e75ee7de 370
d7083042 371 devc = sdi->priv;
d7083042 372
597deef9 373 sr_sw_limits_acquisition_start(&devc->limits);
bee2b016 374 std_session_send_df_header(sdi);
d7083042 375
d7083042
HV
376 devc->req_sent_at = 0;
377 serial = sdi->conn;
378 serial_source_add(sdi->session, serial, G_IO_IN,
16fc7ee2
UH
379 KAXXXXP_POLL_INTERVAL_MS,
380 korad_kaxxxxp_receive_data, (void *)sdi);
e75ee7de
HV
381
382 return SR_OK;
383}
384
dd5c48a6 385static struct sr_dev_driver korad_kaxxxxp_driver_info = {
16fc7ee2
UH
386 .name = "korad-kaxxxxp",
387 .longname = "Korad KAxxxxP",
e75ee7de 388 .api_version = 1,
c2fdcc25 389 .init = std_init,
700d6b64 390 .cleanup = std_cleanup,
e75ee7de 391 .scan = scan,
c01bf34c 392 .dev_list = std_dev_list,
f778bf02 393 .dev_clear = std_dev_clear,
e75ee7de
HV
394 .config_get = config_get,
395 .config_set = config_set,
396 .config_list = config_list,
d7083042 397 .dev_open = std_serial_dev_open,
3f9b48ae 398 .dev_close = dev_close,
e75ee7de 399 .dev_acquisition_start = dev_acquisition_start,
4b1a9d5d 400 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
e75ee7de
HV
401 .context = NULL,
402};
dd5c48a6 403SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);