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",
58 1, volts_30, amps_5, 0},
59 /* Sometimes the KA3005P has an extra 0x01 after the ID. */
60 {"Korad", "KA3005P", "KORADKA3005PV2.0\x01",
61 1, volts_30, amps_5, 0},
62 /* Sometimes the KA3005P has an extra 0xBC after the ID. */
63 {"Korad", "KA3005P", "KORADKA3005PV2.0\xBC",
64 1, volts_30, amps_5, 0},
65 {"Korad", "KA3005P", "KORAD KA3005P V4.2",
66 1, volts_30, amps_5, 0},
67 {"Korad", "KA3005P", "KORAD KA3005P V5.5",
68 1, volts_30, amps_5, 0},
69 {"Korad", "KD3005P", "KORAD KD3005P V2.0",
70 1, volts_30, amps_5, 0},
71 {"Korad", "KD3005P", "KORADKD3005PV2.0",
72 1, volts_30, amps_5, 0},
73 {"Korad", "KD3005P", "KORADKD3005PV2.1",
74 1, volts_30, amps_5, 0},
75 {"Korad", "KD3005P", "KORAD KD3005P V4.1",
76 1, volts_30, amps_5, 0},
77 {"Korad", "KD3005P", "KORAD KD3005P V6.8",
78 1, volts_30, amps_5, 0},
79 {"Korad", "KD6005P", "KORAD KD6005P V2.2",
80 1, volts_60, amps_5, 0},
81 {"RND", "KA3005P", "RND 320-KA3005P V5.5",
82 1, volts_30, amps_5, 0},
83 {"RND", "KD3005P", "RND 320-KD3005P V4.2",
84 1, volts_30, amps_5, 0},
85 {"RND", "KA3005P", "RND 320-KA3005P V2.0",
86 1, volts_30, amps_5, 0},
87 {"Stamos Soldering", "S-LS-31", "S-LS-31 V2.0",
88 1, volts_30, amps_5, 0},
89 {"Tenma", "72-2535", "TENMA 72-2535 V2.1",
90 1, volts_30, amps_3, 0},
91 {"Tenma", "72-2540", "TENMA72-2540V2.0",
92 1, volts_30, amps_5, 0},
93 {"Tenma", "72-2540", "TENMA 72-2540 V2.1",
94 1, volts_30, amps_5, 0},
95 {"Tenma", "72-2540", "TENMA 72-2540 V5.2",
96 1, volts_30, amps_5, 0},
97 {"Tenma", "72-2550", "TENMA72-2550V2.0",
98 1, volts_60, amps_3, 0},
99 {"Tenma", "72-2710", "TENMA 72-2710 V6.6",
100 1, volts_30, amps_5, 0},
101 {"Velleman", "LABPS3005D", "VELLEMANLABPS3005DV2.0",
102 1, volts_30, amps_5, KORAD_QUIRK_LABPS_OVP_EN},
103 {"Velleman", "PS3005D", "VELLEMANPS3005DV2.0",
104 1, volts_30, amps_5, 0},
108 static GSList *scan(struct sr_dev_driver *di, GSList *options)
110 static const char *serno_prefix = " SN:";
112 struct dev_context *devc;
114 struct sr_dev_inst *sdi;
115 struct sr_config *src;
116 const char *conn, *serialcomm;
117 const char *force_detect;
118 struct sr_serial_dev_inst *serial;
122 const struct korad_kaxxxxp_model *model;
130 for (l = options; l; l = l->next) {
134 conn = g_variant_get_string(src->data, NULL);
136 case SR_CONF_SERIALCOMM:
137 serialcomm = g_variant_get_string(src->data, NULL);
139 case SR_CONF_FORCE_DETECT:
140 force_detect = g_variant_get_string(src->data, NULL);
143 sr_err("Unknown option %d, skipping.", src->key);
151 serialcomm = "9600/8n1";
152 if (force_detect && !*force_detect)
155 serial = sr_serial_dev_inst_new(conn, serialcomm);
156 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
160 * Prepare a receive buffer for the identification response that
161 * is large enough to hold the longest known model name, and an
162 * optional serial number. Communicate the identification request.
165 for (i = 0; models[i].id; i++) {
166 if (len < strlen(models[i].id))
167 len = strlen(models[i].id);
169 len += strlen(serno_prefix) + 12;
170 if (len > sizeof(reply) - 1)
171 len = sizeof(reply) - 1;
172 sr_dbg("Want max %zu bytes.", len);
174 ret = korad_kaxxxxp_send_cmd(serial, "*IDN?");
178 ret = korad_kaxxxxp_read_chars(serial, len, reply);
181 sr_dbg("Received: %d, %s", ret, reply);
184 * Isolate the optional serial number at the response's end.
185 * Lookup the response's model ID in the list of known models.
187 serno = g_strrstr(reply, serno_prefix);
190 serno += strlen(serno_prefix);
194 for (i = 0; models[i].id; i++) {
195 if (g_strcmp0(models[i].id, reply) != 0)
200 if (!model && force_detect) {
201 sr_warn("Found model ID '%s' is unknown, trying '%s' spec.",
202 reply, force_detect);
203 for (i = 0; models[i].id; i++) {
204 if (strcmp(models[i].id, force_detect) != 0)
206 sr_info("Found replacement, using it instead.");
212 sr_err("Unknown model ID '%s' detected, aborting.", reply);
215 sr_dbg("Found: %s %s (idx %zu, ID '%s').", model->vendor, model->name,
216 model - &models[0], model->id);
218 sdi = g_malloc0(sizeof(struct sr_dev_inst));
219 sdi->status = SR_ST_INACTIVE;
220 sdi->vendor = g_strdup(model->vendor);
221 sdi->model = g_strdup(model->name);
223 sdi->serial_num = g_strdup(serno);
224 sdi->inst_type = SR_INST_SERIAL;
226 sdi->connection_id = g_strdup(conn);
228 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
229 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
231 devc = g_malloc0(sizeof(struct dev_context));
232 sr_sw_limits_init(&devc->limits);
233 g_mutex_init(&devc->rw_mutex);
235 devc->req_sent_at = 0;
236 devc->cc_mode_1_changed = FALSE;
237 devc->cc_mode_2_changed = FALSE;
238 devc->output_enabled_changed = FALSE;
239 devc->ocp_enabled_changed = FALSE;
240 devc->ovp_enabled_changed = FALSE;
243 /* Get current status of device. */
244 if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
247 serial_close(serial);
249 return std_scan_complete(di, g_slist_append(NULL, sdi));
252 sr_dev_inst_free(sdi);
254 sr_dbg("Scan failed.");
259 static int config_get(uint32_t key, GVariant **data,
260 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
262 struct dev_context *devc;
272 case SR_CONF_LIMIT_SAMPLES:
273 case SR_CONF_LIMIT_MSEC:
274 return sr_sw_limits_config_get(&devc->limits, key, data);
276 *data = g_variant_new_string(sdi->connection_id);
278 case SR_CONF_VOLTAGE:
279 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
280 *data = g_variant_new_double(devc->voltage);
282 case SR_CONF_VOLTAGE_TARGET:
283 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc);
284 *data = g_variant_new_double(devc->voltage_target);
286 case SR_CONF_CURRENT:
287 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
288 *data = g_variant_new_double(devc->current);
290 case SR_CONF_CURRENT_LIMIT:
291 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc);
292 *data = g_variant_new_double(devc->current_limit);
294 case SR_CONF_ENABLED:
295 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
296 *data = g_variant_new_boolean(devc->output_enabled);
298 case SR_CONF_REGULATION:
299 /* Dual channel not supported. */
300 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
301 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
303 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
304 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
305 *data = g_variant_new_boolean(devc->ocp_enabled);
307 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
308 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
309 *data = g_variant_new_boolean(devc->ovp_enabled);
318 static int config_set(uint32_t key, GVariant *data,
319 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
321 struct dev_context *devc;
330 case SR_CONF_LIMIT_MSEC:
331 case SR_CONF_LIMIT_SAMPLES:
332 return sr_sw_limits_config_set(&devc->limits, key, data);
333 case SR_CONF_VOLTAGE_TARGET:
334 dval = g_variant_get_double(data);
335 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
337 devc->set_voltage_target = dval;
338 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc) < 0)
341 case SR_CONF_CURRENT_LIMIT:
342 dval = g_variant_get_double(data);
343 if (dval < devc->model->current[0] || dval > devc->model->current[1])
345 devc->set_current_limit = dval;
346 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc) < 0)
349 case SR_CONF_ENABLED:
350 bval = g_variant_get_boolean(data);
351 /* Set always so it is possible turn off with sigrok-cli. */
352 devc->set_output_enabled = bval;
353 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
356 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
357 bval = g_variant_get_boolean(data);
358 devc->set_ocp_enabled = bval;
359 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
362 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
363 bval = g_variant_get_boolean(data);
364 devc->set_ovp_enabled = bval;
365 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
375 static int config_list(uint32_t key, GVariant **data,
376 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
378 struct dev_context *devc;
380 devc = (sdi) ? sdi->priv : NULL;
383 case SR_CONF_SCAN_OPTIONS:
384 case SR_CONF_DEVICE_OPTIONS:
385 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
386 case SR_CONF_VOLTAGE_TARGET:
387 if (!devc || !devc->model)
389 *data = std_gvar_min_max_step_array(devc->model->voltage);
391 case SR_CONF_CURRENT_LIMIT:
392 if (!devc || !devc->model)
394 *data = std_gvar_min_max_step_array(devc->model->current);
403 static int dev_close(struct sr_dev_inst *sdi)
405 struct dev_context *devc;
407 devc = (sdi) ? sdi->priv : NULL;
409 g_mutex_clear(&devc->rw_mutex);
411 return std_serial_dev_close(sdi);
414 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
416 struct dev_context *devc;
417 struct sr_serial_dev_inst *serial;
421 sr_sw_limits_acquisition_start(&devc->limits);
422 std_session_send_df_header(sdi);
424 devc->req_sent_at = 0;
426 serial_source_add(sdi->session, serial, G_IO_IN,
427 KAXXXXP_POLL_INTERVAL_MS,
428 korad_kaxxxxp_receive_data, (void *)sdi);
433 static struct sr_dev_driver korad_kaxxxxp_driver_info = {
434 .name = "korad-kaxxxxp",
435 .longname = "Korad KAxxxxP",
438 .cleanup = std_cleanup,
440 .dev_list = std_dev_list,
441 .dev_clear = std_dev_clear,
442 .config_get = config_get,
443 .config_set = config_set,
444 .config_list = config_list,
445 .dev_open = std_serial_dev_open,
446 .dev_close = dev_close,
447 .dev_acquisition_start = dev_acquisition_start,
448 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
451 SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);