]> sigrok.org Git - libsigrok.git/blame - src/hardware/korad-kaxxxxp/api.c
korad-kaxxxxp: unclutter table layout of supported models
[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,
e37e301e 27 SR_CONF_FORCE_DETECT,
d7083042
HV
28};
29
55fb76b3 30static const uint32_t drvopts[] = {
55fb76b3
UH
31 SR_CONF_POWER_SUPPLY,
32};
33
d7083042 34static const uint32_t devopts[] = {
048250d0 35 SR_CONF_CONN | SR_CONF_GET,
d7083042
HV
36 SR_CONF_CONTINUOUS,
37 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
38 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
d7083042
HV
39 SR_CONF_VOLTAGE | SR_CONF_GET,
40 SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
41 SR_CONF_CURRENT | SR_CONF_GET,
42 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
43 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
b16d975a 44 SR_CONF_REGULATION | SR_CONF_GET,
c40ed60f
HV
45 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
46 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
d7083042
HV
47};
48
ecd4600b
GS
49/* Voltage and current ranges. Values are: Min, max, step. */
50static const double volts_30[] = { 0, 31, 0.01, };
51static const double volts_60[] = { 0, 61, 0.01, };
52static const double amps_3[] = { 0, 3.1, 0.001, };
53static const double amps_5[] = { 0, 5.1, 0.001, };
54
16fc7ee2 55static const struct korad_kaxxxxp_model models[] = {
c55adfa1 56 /* Vendor, model name, ID reply, channels, voltage, current, quirks. */
942afb5a
GS
57 {"Korad", "KA3005P", "KORADKA3005PV2.0", 1, volts_30, amps_5, 0},
58 /* Some KA3005P have extra bytes after the ID text. */
59 {"Korad", "KA3005P", "KORADKA3005PV2.0\x01", 1, volts_30, amps_5, 0},
60 {"Korad", "KA3005P", "KORADKA3005PV2.0\xBC", 1, volts_30, amps_5, 0},
61 {"Korad", "KA3005P", "KORAD KA3005P V4.2", 1, volts_30, amps_5, 0},
62 {"Korad", "KA3005P", "KORAD KA3005P V5.5", 1, volts_30, amps_5, 0},
63 {"Korad", "KD3005P", "KORAD KD3005P V2.0", 1, volts_30, amps_5, 0},
64 {"Korad", "KD3005P", "KORADKD3005PV2.0", 1, volts_30, amps_5, 0},
65 {"Korad", "KD3005P", "KORADKD3005PV2.1", 1, volts_30, amps_5, 0},
66 {"Korad", "KD3005P", "KORAD KD3005P V4.1", 1, volts_30, amps_5, 0},
67 {"Korad", "KD3005P", "KORAD KD3005P V6.8", 1, volts_30, amps_5, 0},
68 {"Korad", "KD6005P", "KORAD KD6005P V2.2", 1, volts_60, amps_5, 0},
69 {"RND", "KA3005P", "RND 320-KA3005P V5.5", 1, volts_30, amps_5, 0},
70 {"RND", "KD3005P", "RND 320-KD3005P V4.2", 1, volts_30, amps_5, 0},
71 {"RND", "KA3005P", "RND 320-KA3005P V2.0", 1, volts_30, amps_5, 0},
72 {"Stamos Soldering", "S-LS-31", "S-LS-31 V2.0", 1, volts_30, amps_5, 0},
73 {"Tenma", "72-2535", "TENMA 72-2535 V2.1", 1, volts_30, amps_3, 0},
74 {"Tenma", "72-2540", "TENMA72-2540V2.0", 1, volts_30, amps_5, 0},
75 {"Tenma", "72-2540", "TENMA 72-2540 V2.1", 1, volts_30, amps_5, 0},
76 {"Tenma", "72-2540", "TENMA 72-2540 V5.2", 1, volts_30, amps_5, 0},
77 {"Tenma", "72-2550", "TENMA72-2550V2.0", 1, volts_60, amps_3, 0},
78 {"Tenma", "72-2710", "TENMA 72-2710 V6.6", 1, volts_30, amps_5, 0},
c55adfa1 79 {"Velleman", "LABPS3005D", "VELLEMANLABPS3005DV2.0",
c7275098 80 1, volts_30, amps_5, KORAD_QUIRK_LABPS_OVP_EN},
c55adfa1 81 {"Velleman", "PS3005D", "VELLEMANPS3005DV2.0",
c7275098 82 1, volts_30, amps_5, 0},
9e9dba7b 83 ALL_ZERO
d7083042
HV
84};
85
e75ee7de
HV
86static GSList *scan(struct sr_dev_driver *di, GSList *options)
87{
fcacf532
GS
88 static const char *serno_prefix = " SN:";
89
d7083042 90 struct dev_context *devc;
43376f33 91 GSList *l;
d7083042
HV
92 struct sr_dev_inst *sdi;
93 struct sr_config *src;
94 const char *conn, *serialcomm;
e37e301e 95 const char *force_detect;
d7083042 96 struct sr_serial_dev_inst *serial;
5255f856 97 size_t i;
d7083042 98 char reply[50];
5255f856
GS
99 int ret;
100 const struct korad_kaxxxxp_model *model;
fcacf532
GS
101 size_t len;
102 char *serno;
e75ee7de 103
d7083042
HV
104 conn = NULL;
105 serialcomm = NULL;
e37e301e 106 force_detect = 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;
e37e301e
GS
117 case SR_CONF_FORCE_DETECT:
118 force_detect = g_variant_get_string(src->data, NULL);
119 break;
d7083042
HV
120 default:
121 sr_err("Unknown option %d, skipping.", src->key);
122 break;
123 }
124 }
125
126 if (!conn)
127 return NULL;
128 if (!serialcomm)
129 serialcomm = "9600/8n1";
e37e301e
GS
130 if (force_detect && !*force_detect)
131 force_detect = NULL;
d7083042
HV
132
133 serial = sr_serial_dev_inst_new(conn, serialcomm);
134 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
135 return NULL;
136
fcacf532
GS
137 /*
138 * Prepare a receive buffer for the identification response that
139 * is large enough to hold the longest known model name, and an
140 * optional serial number. Communicate the identification request.
141 */
d7083042
HV
142 len = 0;
143 for (i = 0; models[i].id; i++) {
fcacf532 144 if (len < strlen(models[i].id))
d7083042
HV
145 len = strlen(models[i].id);
146 }
fcacf532
GS
147 len += strlen(serno_prefix) + 12;
148 if (len > sizeof(reply) - 1)
149 len = sizeof(reply) - 1;
150 sr_dbg("Want max %zu bytes.", len);
cf6beeb2 151
fcacf532
GS
152 ret = korad_kaxxxxp_send_cmd(serial, "*IDN?");
153 if (ret < 0)
d7083042
HV
154 return NULL;
155
fcacf532
GS
156 ret = korad_kaxxxxp_read_chars(serial, len, reply);
157 if (ret < 0)
d7083042 158 return NULL;
fcacf532 159 sr_dbg("Received: %d, %s", ret, reply);
cf6beeb2 160
fcacf532
GS
161 /*
162 * Isolate the optional serial number at the response's end.
163 * Lookup the response's model ID in the list of known models.
164 */
165 serno = g_strrstr(reply, serno_prefix);
166 if (serno) {
167 *serno = '\0';
168 serno += strlen(serno_prefix);
169 }
cf6beeb2 170
5255f856 171 model = NULL;
d7083042 172 for (i = 0; models[i].id; i++) {
fcacf532
GS
173 if (g_strcmp0(models[i].id, reply) != 0)
174 continue;
5255f856 175 model = &models[i];
fcacf532 176 break;
d7083042 177 }
5255f856 178 if (!model && force_detect) {
e37e301e
GS
179 sr_warn("Found model ID '%s' is unknown, trying '%s' spec.",
180 reply, force_detect);
181 for (i = 0; models[i].id; i++) {
182 if (strcmp(models[i].id, force_detect) != 0)
183 continue;
184 sr_info("Found replacement, using it instead.");
5255f856 185 model = &models[i];
e37e301e
GS
186 break;
187 }
188 }
5255f856 189 if (!model) {
d7083042
HV
190 sr_err("Unknown model ID '%s' detected, aborting.", reply);
191 return NULL;
192 }
5255f856
GS
193 sr_dbg("Found: %s %s (idx %zu, ID '%s').", model->vendor, model->name,
194 model - &models[0], model->id);
d7083042 195
d7083042
HV
196 sdi = g_malloc0(sizeof(struct sr_dev_inst));
197 sdi->status = SR_ST_INACTIVE;
5255f856
GS
198 sdi->vendor = g_strdup(model->vendor);
199 sdi->model = g_strdup(model->name);
fcacf532
GS
200 if (serno)
201 sdi->serial_num = g_strdup(serno);
d7083042
HV
202 sdi->inst_type = SR_INST_SERIAL;
203 sdi->conn = serial;
048250d0 204 sdi->connection_id = g_strdup(conn);
d7083042 205
23165d7b
FS
206 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
207 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
d7083042
HV
208
209 devc = g_malloc0(sizeof(struct dev_context));
597deef9 210 sr_sw_limits_init(&devc->limits);
3f9b48ae 211 g_mutex_init(&devc->rw_mutex);
5255f856 212 devc->model = model;
d7083042 213 devc->req_sent_at = 0;
2e129b8b
FS
214 devc->cc_mode_1_changed = FALSE;
215 devc->cc_mode_2_changed = FALSE;
216 devc->output_enabled_changed = FALSE;
217 devc->ocp_enabled_changed = FALSE;
218 devc->ovp_enabled_changed = FALSE;
d7083042
HV
219 sdi->priv = devc;
220
221 /* Get current status of device. */
16fc7ee2 222 if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
d7083042 223 goto exit_err;
d7083042
HV
224
225 serial_close(serial);
e75ee7de 226
43376f33 227 return std_scan_complete(di, g_slist_append(NULL, sdi));
d7083042
HV
228
229exit_err:
230 sr_dev_inst_free(sdi);
231 g_free(devc);
232 sr_dbg("Scan failed.");
233
234 return NULL;
e75ee7de
HV
235}
236
e75ee7de
HV
237static int config_get(uint32_t key, GVariant **data,
238 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
239{
d7083042 240 struct dev_context *devc;
e75ee7de 241
e75ee7de
HV
242 (void)cg;
243
d7083042
HV
244 if (!sdi || !data)
245 return SR_ERR_ARG;
246
247 devc = sdi->priv;
248
e75ee7de 249 switch (key) {
cd04f641
UH
250 case SR_CONF_LIMIT_SAMPLES:
251 case SR_CONF_LIMIT_MSEC:
597deef9 252 return sr_sw_limits_config_get(&devc->limits, key, data);
048250d0
GS
253 case SR_CONF_CONN:
254 *data = g_variant_new_string(sdi->connection_id);
255 break;
d7083042 256 case SR_CONF_VOLTAGE:
3f9b48ae 257 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
d7083042
HV
258 *data = g_variant_new_double(devc->voltage);
259 break;
260 case SR_CONF_VOLTAGE_TARGET:
8da30037
FS
261 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc);
262 *data = g_variant_new_double(devc->voltage_target);
d7083042
HV
263 break;
264 case SR_CONF_CURRENT:
3f9b48ae 265 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
d7083042
HV
266 *data = g_variant_new_double(devc->current);
267 break;
268 case SR_CONF_CURRENT_LIMIT:
8da30037
FS
269 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc);
270 *data = g_variant_new_double(devc->current_limit);
d7083042
HV
271 break;
272 case SR_CONF_ENABLED:
3f9b48ae 273 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
d7083042
HV
274 *data = g_variant_new_boolean(devc->output_enabled);
275 break;
b16d975a
HV
276 case SR_CONF_REGULATION:
277 /* Dual channel not supported. */
3f9b48ae 278 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
9e5366df 279 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
b16d975a 280 break;
c40ed60f 281 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
3f9b48ae 282 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
9e5366df 283 *data = g_variant_new_boolean(devc->ocp_enabled);
c40ed60f
HV
284 break;
285 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
3f9b48ae 286 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
9e5366df 287 *data = g_variant_new_boolean(devc->ovp_enabled);
c40ed60f 288 break;
e75ee7de
HV
289 default:
290 return SR_ERR_NA;
291 }
292
d7083042 293 return SR_OK;
e75ee7de
HV
294}
295
296static int config_set(uint32_t key, GVariant *data,
297 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
298{
d7083042
HV
299 struct dev_context *devc;
300 double dval;
301 gboolean bval;
e75ee7de 302
e75ee7de
HV
303 (void)cg;
304
d7083042
HV
305 devc = sdi->priv;
306
e75ee7de 307 switch (key) {
d7083042 308 case SR_CONF_LIMIT_MSEC:
d7083042 309 case SR_CONF_LIMIT_SAMPLES:
597deef9 310 return sr_sw_limits_config_set(&devc->limits, key, data);
d7083042
HV
311 case SR_CONF_VOLTAGE_TARGET:
312 dval = g_variant_get_double(data);
313 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
314 return SR_ERR_ARG;
8da30037
FS
315 devc->set_voltage_target = dval;
316 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc) < 0)
d7083042
HV
317 return SR_ERR;
318 break;
319 case SR_CONF_CURRENT_LIMIT:
320 dval = g_variant_get_double(data);
321 if (dval < devc->model->current[0] || dval > devc->model->current[1])
322 return SR_ERR_ARG;
8da30037
FS
323 devc->set_current_limit = dval;
324 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc) < 0)
d7083042
HV
325 return SR_ERR;
326 break;
327 case SR_CONF_ENABLED:
328 bval = g_variant_get_boolean(data);
329 /* Set always so it is possible turn off with sigrok-cli. */
8da30037 330 devc->set_output_enabled = bval;
3f9b48ae 331 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
d7083042 332 return SR_ERR;
c40ed60f
HV
333 break;
334 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
335 bval = g_variant_get_boolean(data);
8da30037 336 devc->set_ocp_enabled = bval;
3f9b48ae 337 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
c40ed60f
HV
338 return SR_ERR;
339 break;
340 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
341 bval = g_variant_get_boolean(data);
8da30037 342 devc->set_ovp_enabled = bval;
3f9b48ae 343 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
c40ed60f 344 return SR_ERR;
d7083042 345 break;
e75ee7de 346 default:
d7083042 347 return SR_ERR_NA;
e75ee7de
HV
348 }
349
d7083042 350 return SR_OK;
e75ee7de
HV
351}
352
353static int config_list(uint32_t key, GVariant **data,
354 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
355{
d7083042 356 struct dev_context *devc;
d7083042 357
e66d1892 358 devc = (sdi) ? sdi->priv : NULL;
d7083042 359
e75ee7de 360 switch (key) {
e66d1892 361 case SR_CONF_SCAN_OPTIONS:
d7083042 362 case SR_CONF_DEVICE_OPTIONS:
e66d1892 363 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
d7083042 364 case SR_CONF_VOLTAGE_TARGET:
fc69eecc
GS
365 if (!devc || !devc->model)
366 return SR_ERR_ARG;
54d471f4 367 *data = std_gvar_min_max_step_array(devc->model->voltage);
d7083042
HV
368 break;
369 case SR_CONF_CURRENT_LIMIT:
fc69eecc
GS
370 if (!devc || !devc->model)
371 return SR_ERR_ARG;
54d471f4 372 *data = std_gvar_min_max_step_array(devc->model->current);
d7083042 373 break;
e75ee7de
HV
374 default:
375 return SR_ERR_NA;
376 }
377
d7083042 378 return SR_OK;
e75ee7de
HV
379}
380
3f9b48ae
FS
381static int dev_close(struct sr_dev_inst *sdi)
382{
383 struct dev_context *devc;
384
385 devc = (sdi) ? sdi->priv : NULL;
386 if (devc)
387 g_mutex_clear(&devc->rw_mutex);
388
389 return std_serial_dev_close(sdi);
390}
391
695dc859 392static int dev_acquisition_start(const struct sr_dev_inst *sdi)
e75ee7de 393{
d7083042
HV
394 struct dev_context *devc;
395 struct sr_serial_dev_inst *serial;
e75ee7de 396
d7083042 397 devc = sdi->priv;
d7083042 398
597deef9 399 sr_sw_limits_acquisition_start(&devc->limits);
bee2b016 400 std_session_send_df_header(sdi);
d7083042 401
d7083042
HV
402 devc->req_sent_at = 0;
403 serial = sdi->conn;
404 serial_source_add(sdi->session, serial, G_IO_IN,
16fc7ee2
UH
405 KAXXXXP_POLL_INTERVAL_MS,
406 korad_kaxxxxp_receive_data, (void *)sdi);
e75ee7de
HV
407
408 return SR_OK;
409}
410
dd5c48a6 411static struct sr_dev_driver korad_kaxxxxp_driver_info = {
16fc7ee2
UH
412 .name = "korad-kaxxxxp",
413 .longname = "Korad KAxxxxP",
e75ee7de 414 .api_version = 1,
c2fdcc25 415 .init = std_init,
700d6b64 416 .cleanup = std_cleanup,
e75ee7de 417 .scan = scan,
c01bf34c 418 .dev_list = std_dev_list,
f778bf02 419 .dev_clear = std_dev_clear,
e75ee7de
HV
420 .config_get = config_get,
421 .config_set = config_set,
422 .config_list = config_list,
d7083042 423 .dev_open = std_serial_dev_open,
3f9b48ae 424 .dev_close = dev_close,
e75ee7de 425 .dev_acquisition_start = dev_acquisition_start,
4b1a9d5d 426 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
e75ee7de
HV
427 .context = NULL,
428};
dd5c48a6 429SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);