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[] = {
29 static const uint32_t drvopts[] = {
33 static const uint32_t devopts[] = {
34 SR_CONF_CONN | SR_CONF_GET,
36 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
37 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
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,
43 SR_CONF_REGULATION | SR_CONF_GET,
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,
48 static const struct korad_kaxxxxp_model models[] = {
49 /* Device enum, vendor, model, ID reply, channels, voltage, current */
50 {VELLEMAN_PS3005D, "Velleman", "PS3005D",
51 "VELLEMANPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
52 {VELLEMAN_LABPS3005D, "Velleman", "LABPS3005D",
53 "VELLEMANLABPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
54 {KORAD_KA3005P, "Korad", "KA3005P",
55 "KORADKA3005PV2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
56 /* Sometimes the KA3005P has an extra 0x01 after the ID. */
57 {KORAD_KA3005P_0X01, "Korad", "KA3005P",
58 "KORADKA3005PV2.0\x01", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
59 /* Sometimes the KA3005P has an extra 0xBC after the ID. */
60 {KORAD_KA3005P_0XBC, "Korad", "KA3005P",
61 "KORADKA3005PV2.0\xBC", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
62 {KORAD_KA3005P_V42, "Korad", "KA3005P",
63 "KORAD KA3005P V4.2", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
64 {KORAD_KA3005P_V55, "Korad", "KA3005P",
65 "KORAD KA3005P V5.5", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
66 {KORAD_KD3005P, "Korad", "KD3005P",
67 "KORAD KD3005P V2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
68 {KORAD_KD3005P_V20_NOSP, "Korad", "KD3005P",
69 "KORADKD3005PV2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
70 {RND_320_KD3005P, "RND", "KD3005P",
71 "RND 320-KD3005P V4.2", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
72 {RND_320_KA3005P, "RND", "KA3005P",
73 "RND 320-KA3005P V5.5", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
74 {RND_320K30PV, "RND", "KA3005P",
75 "RND 320-KA3005P V2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
76 {TENMA_72_2550_V2, "Tenma", "72-2550",
77 "TENMA72-2550V2.0", 1, {0, 61, 0.01}, {0, 3.1, 0.001}},
78 {TENMA_72_2540_V20, "Tenma", "72-2540",
79 "TENMA72-2540V2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
80 {TENMA_72_2540_V21, "Tenma", "72-2540",
81 "TENMA 72-2540 V2.1", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
82 {TENMA_72_2540_V52, "Tenma", "72-2540",
83 "TENMA 72-2540 V5.2", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
84 {TENMA_72_2535_V21, "Tenma", "72-2535",
85 "TENMA 72-2535 V2.1", 1, {0, 31, 0.01}, {0, 3.1, 0.001}},
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}},
88 {KORAD_KD6005P, "Korad", "KD6005P",
89 "KORAD KD6005P V2.2", 1, {0, 61, 0.01}, {0, 5.1, 0.001}},
93 static GSList *scan(struct sr_dev_driver *di, GSList *options)
95 struct dev_context *devc;
97 struct sr_dev_inst *sdi;
98 struct sr_config *src;
99 const char *conn, *serialcomm;
100 struct sr_serial_dev_inst *serial;
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);
118 sr_err("Unknown option %d, skipping.", src->key);
126 serialcomm = "9600/8n1";
128 serial = sr_serial_dev_inst_new(conn, serialcomm);
129 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
132 /* Get the device model. */
134 for (i = 0; models[i].id; i++) {
135 if (strlen(models[i].id) > len)
136 len = strlen(models[i].id);
140 * Some models also include the serial number:
141 * RND 320-KD3005P V4.2 SN:59834414
145 memset(&reply, 0, sizeof(reply));
146 sr_dbg("Want max %d bytes.", len);
147 if ((korad_kaxxxxp_send_cmd(serial, "*IDN?") < 0))
150 /* i is used here for debug purposes only. */
151 if ((i = korad_kaxxxxp_read_chars(serial, len, reply)) < 0)
153 sr_dbg("Received: %d, %s", i, reply);
156 /* Truncate before serial number. */
157 char *sn = g_strrstr(reply, " SN:");
161 for (i = 0; models[i].id; i++) {
162 if (!g_strcmp0(models[i].id, reply))
166 sr_err("Unknown model ID '%s' detected, aborting.", reply);
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);
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;
178 sdi->connection_id = g_strdup(conn);
180 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
181 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
183 devc = g_malloc0(sizeof(struct dev_context));
184 sr_sw_limits_init(&devc->limits);
185 g_mutex_init(&devc->rw_mutex);
186 devc->model = &models[model_id];
187 devc->req_sent_at = 0;
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;
195 /* Get current status of device. */
196 if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
199 serial_close(serial);
201 return std_scan_complete(di, g_slist_append(NULL, sdi));
204 sr_dev_inst_free(sdi);
206 sr_dbg("Scan failed.");
211 static int config_get(uint32_t key, GVariant **data,
212 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
214 struct dev_context *devc;
224 case SR_CONF_LIMIT_SAMPLES:
225 case SR_CONF_LIMIT_MSEC:
226 return sr_sw_limits_config_get(&devc->limits, key, data);
228 *data = g_variant_new_string(sdi->connection_id);
230 case SR_CONF_VOLTAGE:
231 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
232 *data = g_variant_new_double(devc->voltage);
234 case SR_CONF_VOLTAGE_TARGET:
235 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc);
236 *data = g_variant_new_double(devc->voltage_target);
238 case SR_CONF_CURRENT:
239 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
240 *data = g_variant_new_double(devc->current);
242 case SR_CONF_CURRENT_LIMIT:
243 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc);
244 *data = g_variant_new_double(devc->current_limit);
246 case SR_CONF_ENABLED:
247 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
248 *data = g_variant_new_boolean(devc->output_enabled);
250 case SR_CONF_REGULATION:
251 /* Dual channel not supported. */
252 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
253 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
255 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
256 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
257 *data = g_variant_new_boolean(devc->ocp_enabled);
259 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
260 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
261 *data = g_variant_new_boolean(devc->ovp_enabled);
270 static int config_set(uint32_t key, GVariant *data,
271 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
273 struct dev_context *devc;
282 case SR_CONF_LIMIT_MSEC:
283 case SR_CONF_LIMIT_SAMPLES:
284 return sr_sw_limits_config_set(&devc->limits, key, data);
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])
289 devc->set_voltage_target = dval;
290 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc) < 0)
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])
297 devc->set_current_limit = dval;
298 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc) < 0)
301 case SR_CONF_ENABLED:
302 bval = g_variant_get_boolean(data);
303 /* Set always so it is possible turn off with sigrok-cli. */
304 devc->set_output_enabled = bval;
305 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
308 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
309 bval = g_variant_get_boolean(data);
310 devc->set_ocp_enabled = bval;
311 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
314 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
315 bval = g_variant_get_boolean(data);
316 devc->set_ovp_enabled = bval;
317 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
327 static int config_list(uint32_t key, GVariant **data,
328 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
330 struct dev_context *devc;
332 devc = (sdi) ? sdi->priv : NULL;
335 case SR_CONF_SCAN_OPTIONS:
336 case SR_CONF_DEVICE_OPTIONS:
337 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
338 case SR_CONF_VOLTAGE_TARGET:
339 if (!devc || !devc->model)
341 *data = std_gvar_min_max_step_array(devc->model->voltage);
343 case SR_CONF_CURRENT_LIMIT:
344 if (!devc || !devc->model)
346 *data = std_gvar_min_max_step_array(devc->model->current);
355 static int dev_close(struct sr_dev_inst *sdi)
357 struct dev_context *devc;
359 devc = (sdi) ? sdi->priv : NULL;
361 g_mutex_clear(&devc->rw_mutex);
363 return std_serial_dev_close(sdi);
366 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
368 struct dev_context *devc;
369 struct sr_serial_dev_inst *serial;
373 sr_sw_limits_acquisition_start(&devc->limits);
374 std_session_send_df_header(sdi);
376 devc->req_sent_at = 0;
378 serial_source_add(sdi->session, serial, G_IO_IN,
379 KAXXXXP_POLL_INTERVAL_MS,
380 korad_kaxxxxp_receive_data, (void *)sdi);
385 static struct sr_dev_driver korad_kaxxxxp_driver_info = {
386 .name = "korad-kaxxxxp",
387 .longname = "Korad KAxxxxP",
390 .cleanup = std_cleanup,
392 .dev_list = std_dev_list,
393 .dev_clear = std_dev_clear,
394 .config_get = config_get,
395 .config_set = config_set,
396 .config_list = config_list,
397 .dev_open = std_serial_dev_open,
398 .dev_close = dev_close,
399 .dev_acquisition_start = dev_acquisition_start,
400 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
403 SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);