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 static const struct korad_kaxxxxp_model models[] = {
50 /* Device enum, vendor, model, ID reply, channels, voltage, current */
51 {KORAD_KA3005P, "Korad", "KA3005P",
52 "KORADKA3005PV2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
53 /* Sometimes the KA3005P has an extra 0x01 after the ID. */
54 {KORAD_KA3005P_0X01, "Korad", "KA3005P",
55 "KORADKA3005PV2.0\x01", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
56 /* Sometimes the KA3005P has an extra 0xBC after the ID. */
57 {KORAD_KA3005P_0XBC, "Korad", "KA3005P",
58 "KORADKA3005PV2.0\xBC", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
59 {KORAD_KA3005P_V42, "Korad", "KA3005P",
60 "KORAD KA3005P V4.2", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
61 {KORAD_KA3005P_V55, "Korad", "KA3005P",
62 "KORAD KA3005P V5.5", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
63 {KORAD_KD3005P_V20, "Korad", "KD3005P",
64 "KORAD KD3005P V2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
65 {KORAD_KD3005P_V20_NOSP, "Korad", "KD3005P",
66 "KORADKD3005PV2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
67 {KORAD_KD3005P_V21_NOSP, "Korad", "KD3005P",
68 "KORADKD3005PV2.1", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
69 {KORAD_KD3005P_V41, "Korad", "KD3005P",
70 "KORAD KD3005P V4.1", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
71 {KORAD_KD3005P_V68, "Korad", "KD3005P",
72 "KORAD KD3005P V6.8", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
73 {KORAD_KD6005P, "Korad", "KD6005P",
74 "KORAD KD6005P V2.2", 1, {0, 61, 0.01}, {0, 5.1, 0.001}},
75 {RND_320_KA3005P, "RND", "KA3005P",
76 "RND 320-KA3005P V5.5", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
77 {RND_320_KD3005P, "RND", "KD3005P",
78 "RND 320-KD3005P V4.2", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
79 {RND_320K30PV, "RND", "KA3005P",
80 "RND 320-KA3005P V2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
81 {STAMOS_SLS31_V20, "Stamos Soldering", "S-LS-31",
82 "S-LS-31 V2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
83 {TENMA_72_2535_V21, "Tenma", "72-2535",
84 "TENMA 72-2535 V2.1", 1, {0, 31, 0.01}, {0, 3.1, 0.001}},
85 {TENMA_72_2540_V20, "Tenma", "72-2540",
86 "TENMA72-2540V2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
87 {TENMA_72_2540_V21, "Tenma", "72-2540",
88 "TENMA 72-2540 V2.1", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
89 {TENMA_72_2540_V52, "Tenma", "72-2540",
90 "TENMA 72-2540 V5.2", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
91 {TENMA_72_2550_V2, "Tenma", "72-2550",
92 "TENMA72-2550V2.0", 1, {0, 61, 0.01}, {0, 3.1, 0.001}},
93 {TENMA_72_2710_V66, "Tenma", "72-2710",
94 "TENMA 72-2710 V6.6", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
95 {VELLEMAN_LABPS3005D, "Velleman", "LABPS3005D",
96 "VELLEMANLABPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
97 {VELLEMAN_PS3005D, "Velleman", "PS3005D",
98 "VELLEMANPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
102 static GSList *scan(struct sr_dev_driver *di, GSList *options)
104 static const char *serno_prefix = " SN:";
106 struct dev_context *devc;
108 struct sr_dev_inst *sdi;
109 struct sr_config *src;
110 const char *conn, *serialcomm;
111 const char *force_detect;
112 struct sr_serial_dev_inst *serial;
114 int ret, i, model_id;
122 for (l = options; l; l = l->next) {
126 conn = g_variant_get_string(src->data, NULL);
128 case SR_CONF_SERIALCOMM:
129 serialcomm = g_variant_get_string(src->data, NULL);
131 case SR_CONF_FORCE_DETECT:
132 force_detect = g_variant_get_string(src->data, NULL);
135 sr_err("Unknown option %d, skipping.", src->key);
143 serialcomm = "9600/8n1";
144 if (force_detect && !*force_detect)
147 serial = sr_serial_dev_inst_new(conn, serialcomm);
148 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
152 * Prepare a receive buffer for the identification response that
153 * is large enough to hold the longest known model name, and an
154 * optional serial number. Communicate the identification request.
157 for (i = 0; models[i].id; i++) {
158 if (len < strlen(models[i].id))
159 len = strlen(models[i].id);
161 len += strlen(serno_prefix) + 12;
162 if (len > sizeof(reply) - 1)
163 len = sizeof(reply) - 1;
164 sr_dbg("Want max %zu bytes.", len);
166 ret = korad_kaxxxxp_send_cmd(serial, "*IDN?");
170 ret = korad_kaxxxxp_read_chars(serial, len, reply);
173 sr_dbg("Received: %d, %s", ret, reply);
176 * Isolate the optional serial number at the response's end.
177 * Lookup the response's model ID in the list of known models.
179 serno = g_strrstr(reply, serno_prefix);
182 serno += strlen(serno_prefix);
186 for (i = 0; models[i].id; i++) {
187 if (g_strcmp0(models[i].id, reply) != 0)
192 if (model_id < 0 && force_detect) {
193 sr_warn("Found model ID '%s' is unknown, trying '%s' spec.",
194 reply, force_detect);
195 for (i = 0; models[i].id; i++) {
196 if (strcmp(models[i].id, force_detect) != 0)
198 sr_info("Found replacement, using it instead.");
204 sr_err("Unknown model ID '%s' detected, aborting.", reply);
207 sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor,
208 models[model_id].name, model_id, models[model_id].id);
210 sdi = g_malloc0(sizeof(struct sr_dev_inst));
211 sdi->status = SR_ST_INACTIVE;
212 sdi->vendor = g_strdup(models[model_id].vendor);
213 sdi->model = g_strdup(models[model_id].name);
215 sdi->serial_num = g_strdup(serno);
216 sdi->inst_type = SR_INST_SERIAL;
218 sdi->connection_id = g_strdup(conn);
220 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
221 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
223 devc = g_malloc0(sizeof(struct dev_context));
224 sr_sw_limits_init(&devc->limits);
225 g_mutex_init(&devc->rw_mutex);
226 devc->model = &models[model_id];
227 devc->req_sent_at = 0;
228 devc->cc_mode_1_changed = FALSE;
229 devc->cc_mode_2_changed = FALSE;
230 devc->output_enabled_changed = FALSE;
231 devc->ocp_enabled_changed = FALSE;
232 devc->ovp_enabled_changed = FALSE;
235 /* Get current status of device. */
236 if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
239 serial_close(serial);
241 return std_scan_complete(di, g_slist_append(NULL, sdi));
244 sr_dev_inst_free(sdi);
246 sr_dbg("Scan failed.");
251 static int config_get(uint32_t key, GVariant **data,
252 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
254 struct dev_context *devc;
264 case SR_CONF_LIMIT_SAMPLES:
265 case SR_CONF_LIMIT_MSEC:
266 return sr_sw_limits_config_get(&devc->limits, key, data);
268 *data = g_variant_new_string(sdi->connection_id);
270 case SR_CONF_VOLTAGE:
271 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
272 *data = g_variant_new_double(devc->voltage);
274 case SR_CONF_VOLTAGE_TARGET:
275 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc);
276 *data = g_variant_new_double(devc->voltage_target);
278 case SR_CONF_CURRENT:
279 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
280 *data = g_variant_new_double(devc->current);
282 case SR_CONF_CURRENT_LIMIT:
283 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc);
284 *data = g_variant_new_double(devc->current_limit);
286 case SR_CONF_ENABLED:
287 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
288 *data = g_variant_new_boolean(devc->output_enabled);
290 case SR_CONF_REGULATION:
291 /* Dual channel not supported. */
292 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
293 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
295 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
296 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
297 *data = g_variant_new_boolean(devc->ocp_enabled);
299 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
300 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
301 *data = g_variant_new_boolean(devc->ovp_enabled);
310 static int config_set(uint32_t key, GVariant *data,
311 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
313 struct dev_context *devc;
322 case SR_CONF_LIMIT_MSEC:
323 case SR_CONF_LIMIT_SAMPLES:
324 return sr_sw_limits_config_set(&devc->limits, key, data);
325 case SR_CONF_VOLTAGE_TARGET:
326 dval = g_variant_get_double(data);
327 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
329 devc->set_voltage_target = dval;
330 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc) < 0)
333 case SR_CONF_CURRENT_LIMIT:
334 dval = g_variant_get_double(data);
335 if (dval < devc->model->current[0] || dval > devc->model->current[1])
337 devc->set_current_limit = dval;
338 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc) < 0)
341 case SR_CONF_ENABLED:
342 bval = g_variant_get_boolean(data);
343 /* Set always so it is possible turn off with sigrok-cli. */
344 devc->set_output_enabled = bval;
345 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
348 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
349 bval = g_variant_get_boolean(data);
350 devc->set_ocp_enabled = bval;
351 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
354 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
355 bval = g_variant_get_boolean(data);
356 devc->set_ovp_enabled = bval;
357 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
367 static int config_list(uint32_t key, GVariant **data,
368 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
370 struct dev_context *devc;
372 devc = (sdi) ? sdi->priv : NULL;
375 case SR_CONF_SCAN_OPTIONS:
376 case SR_CONF_DEVICE_OPTIONS:
377 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
378 case SR_CONF_VOLTAGE_TARGET:
379 if (!devc || !devc->model)
381 *data = std_gvar_min_max_step_array(devc->model->voltage);
383 case SR_CONF_CURRENT_LIMIT:
384 if (!devc || !devc->model)
386 *data = std_gvar_min_max_step_array(devc->model->current);
395 static int dev_close(struct sr_dev_inst *sdi)
397 struct dev_context *devc;
399 devc = (sdi) ? sdi->priv : NULL;
401 g_mutex_clear(&devc->rw_mutex);
403 return std_serial_dev_close(sdi);
406 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
408 struct dev_context *devc;
409 struct sr_serial_dev_inst *serial;
413 sr_sw_limits_acquisition_start(&devc->limits);
414 std_session_send_df_header(sdi);
416 devc->req_sent_at = 0;
418 serial_source_add(sdi->session, serial, G_IO_IN,
419 KAXXXXP_POLL_INTERVAL_MS,
420 korad_kaxxxxp_receive_data, (void *)sdi);
425 static struct sr_dev_driver korad_kaxxxxp_driver_info = {
426 .name = "korad-kaxxxxp",
427 .longname = "Korad KAxxxxP",
430 .cleanup = std_cleanup,
432 .dev_list = std_dev_list,
433 .dev_clear = std_dev_clear,
434 .config_get = config_get,
435 .config_set = config_set,
436 .config_list = config_list,
437 .dev_open = std_serial_dev_open,
438 .dev_close = dev_close,
439 .dev_acquisition_start = dev_acquisition_start,
440 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
443 SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);