2 * This file is part of the libsigrok project.
4 * Copyright (C) 2015 Hannu Vuolasaho <vuokkosetae@gmail.com>
5 * Copyright (C) 2018-2019 Frank Stettner <frank-stettner@gmx.net>
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.
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.
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/>.
24 static const uint32_t scanopts[] = {
30 static const uint32_t drvopts[] = {
34 static const uint32_t devopts[] = {
35 SR_CONF_CONN | SR_CONF_GET,
37 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
38 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
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,
44 SR_CONF_REGULATION | SR_CONF_GET,
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,
49 /* Voltage and current ranges. Values are: Min, max, step. */
50 static const double volts_30[] = { 0, 31, 0.01, };
51 static const double volts_60[] = { 0, 61, 0.01, };
52 static const double amps_3[] = { 0, 3.1, 0.001, };
53 static const double amps_5[] = { 0, 5.1, 0.001, };
55 static const struct korad_kaxxxxp_model models[] = {
56 /* Vendor, model name, ID reply, channels, voltage, current, quirks. */
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},
79 {"Velleman", "LABPS3005D", "VELLEMANLABPS3005DV2.0",
80 1, volts_30, amps_5, KORAD_QUIRK_LABPS_OVP_EN},
81 {"Velleman", "PS3005D", "VELLEMANPS3005DV2.0",
82 1, volts_30, amps_5, 0},
86 static GSList *scan(struct sr_dev_driver *di, GSList *options)
88 static const char *serno_prefix = " SN:";
90 struct dev_context *devc;
92 struct sr_dev_inst *sdi;
93 struct sr_config *src;
94 const char *conn, *serialcomm;
95 const char *force_detect;
96 struct sr_serial_dev_inst *serial;
100 const struct korad_kaxxxxp_model *model;
108 for (l = options; l; l = l->next) {
112 conn = g_variant_get_string(src->data, NULL);
114 case SR_CONF_SERIALCOMM:
115 serialcomm = g_variant_get_string(src->data, NULL);
117 case SR_CONF_FORCE_DETECT:
118 force_detect = g_variant_get_string(src->data, NULL);
121 sr_err("Unknown option %d, skipping.", src->key);
129 serialcomm = "9600/8n1";
130 if (force_detect && !*force_detect)
133 serial = sr_serial_dev_inst_new(conn, serialcomm);
134 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
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.
143 for (i = 0; models[i].id; i++) {
144 if (len < strlen(models[i].id))
145 len = strlen(models[i].id);
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);
152 ret = korad_kaxxxxp_send_cmd(serial, "*IDN?");
156 ret = korad_kaxxxxp_read_chars(serial, len, reply);
159 sr_dbg("Received: %d, %s", ret, reply);
162 * Isolate the optional serial number at the response's end.
163 * Lookup the response's model ID in the list of known models.
165 serno = g_strrstr(reply, serno_prefix);
168 serno += strlen(serno_prefix);
172 for (i = 0; models[i].id; i++) {
173 if (g_strcmp0(models[i].id, reply) != 0)
178 if (!model && force_detect) {
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)
184 sr_info("Found replacement, using it instead.");
190 sr_err("Unknown model ID '%s' detected, aborting.", reply);
193 sr_dbg("Found: %s %s (idx %zu, ID '%s').", model->vendor, model->name,
194 model - &models[0], model->id);
196 sdi = g_malloc0(sizeof(struct sr_dev_inst));
197 sdi->status = SR_ST_INACTIVE;
198 sdi->vendor = g_strdup(model->vendor);
199 sdi->model = g_strdup(model->name);
201 sdi->serial_num = g_strdup(serno);
202 sdi->inst_type = SR_INST_SERIAL;
204 sdi->connection_id = g_strdup(conn);
206 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
207 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
209 devc = g_malloc0(sizeof(struct dev_context));
210 sr_sw_limits_init(&devc->limits);
211 g_mutex_init(&devc->rw_mutex);
213 devc->req_sent_at = 0;
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;
221 /* Get current status of device. */
222 if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
225 serial_close(serial);
227 return std_scan_complete(di, g_slist_append(NULL, sdi));
230 sr_dev_inst_free(sdi);
232 sr_dbg("Scan failed.");
237 static int config_get(uint32_t key, GVariant **data,
238 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
240 struct dev_context *devc;
250 case SR_CONF_LIMIT_SAMPLES:
251 case SR_CONF_LIMIT_MSEC:
252 return sr_sw_limits_config_get(&devc->limits, key, data);
254 *data = g_variant_new_string(sdi->connection_id);
256 case SR_CONF_VOLTAGE:
257 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
258 *data = g_variant_new_double(devc->voltage);
260 case SR_CONF_VOLTAGE_TARGET:
261 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc);
262 *data = g_variant_new_double(devc->voltage_target);
264 case SR_CONF_CURRENT:
265 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
266 *data = g_variant_new_double(devc->current);
268 case SR_CONF_CURRENT_LIMIT:
269 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc);
270 *data = g_variant_new_double(devc->current_limit);
272 case SR_CONF_ENABLED:
273 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
274 *data = g_variant_new_boolean(devc->output_enabled);
276 case SR_CONF_REGULATION:
277 /* Dual channel not supported. */
278 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
279 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
281 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
282 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
283 *data = g_variant_new_boolean(devc->ocp_enabled);
285 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
286 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
287 *data = g_variant_new_boolean(devc->ovp_enabled);
296 static int config_set(uint32_t key, GVariant *data,
297 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
299 struct dev_context *devc;
308 case SR_CONF_LIMIT_MSEC:
309 case SR_CONF_LIMIT_SAMPLES:
310 return sr_sw_limits_config_set(&devc->limits, key, data);
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])
315 devc->set_voltage_target = dval;
316 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc) < 0)
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])
323 devc->set_current_limit = dval;
324 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc) < 0)
327 case SR_CONF_ENABLED:
328 bval = g_variant_get_boolean(data);
329 /* Set always so it is possible turn off with sigrok-cli. */
330 devc->set_output_enabled = bval;
331 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
334 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
335 bval = g_variant_get_boolean(data);
336 devc->set_ocp_enabled = bval;
337 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
340 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
341 bval = g_variant_get_boolean(data);
342 devc->set_ovp_enabled = bval;
343 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
353 static int config_list(uint32_t key, GVariant **data,
354 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
356 struct dev_context *devc;
358 devc = (sdi) ? sdi->priv : NULL;
361 case SR_CONF_SCAN_OPTIONS:
362 case SR_CONF_DEVICE_OPTIONS:
363 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
364 case SR_CONF_VOLTAGE_TARGET:
365 if (!devc || !devc->model)
367 *data = std_gvar_min_max_step_array(devc->model->voltage);
369 case SR_CONF_CURRENT_LIMIT:
370 if (!devc || !devc->model)
372 *data = std_gvar_min_max_step_array(devc->model->current);
381 static int dev_close(struct sr_dev_inst *sdi)
383 struct dev_context *devc;
385 devc = (sdi) ? sdi->priv : NULL;
387 g_mutex_clear(&devc->rw_mutex);
389 return std_serial_dev_close(sdi);
392 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
394 struct dev_context *devc;
395 struct sr_serial_dev_inst *serial;
399 sr_sw_limits_acquisition_start(&devc->limits);
400 std_session_send_df_header(sdi);
402 devc->req_sent_at = 0;
404 serial_source_add(sdi->session, serial, G_IO_IN,
405 KAXXXXP_POLL_INTERVAL_MS,
406 korad_kaxxxxp_receive_data, (void *)sdi);
411 static struct sr_dev_driver korad_kaxxxxp_driver_info = {
412 .name = "korad-kaxxxxp",
413 .longname = "Korad KAxxxxP",
416 .cleanup = std_cleanup,
418 .dev_list = std_dev_list,
419 .dev_clear = std_dev_clear,
420 .config_get = config_get,
421 .config_set = config_set,
422 .config_list = config_list,
423 .dev_open = std_serial_dev_open,
424 .dev_close = dev_close,
425 .dev_acquisition_start = dev_acquisition_start,
426 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
429 SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);