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/>.
27 static const uint32_t scanopts[] = {
33 static const uint32_t drvopts[] = {
37 static const uint32_t devopts[] = {
38 SR_CONF_CONN | SR_CONF_GET,
40 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
41 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
42 SR_CONF_VOLTAGE | SR_CONF_GET,
43 SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
44 SR_CONF_CURRENT | SR_CONF_GET,
45 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
46 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
47 SR_CONF_REGULATION | SR_CONF_GET,
48 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
49 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
52 /* Voltage and current ranges. Values are: Min, max, step. */
53 static const double volts_30[] = { 0, 31, 0.01, };
54 static const double volts_60[] = { 0, 61, 0.01, };
55 static const double amps_3[] = { 0, 3.1, 0.001, };
56 static const double amps_5[] = { 0, 5.1, 0.001, };
58 static const struct korad_kaxxxxp_model models[] = {
59 /* Vendor, model name, ID reply, channels, voltage, current, quirks. */
60 {"Korad", "KA3005P", "", 1, volts_30, amps_5,
61 KORAD_QUIRK_ID_TRAILING},
62 {"Korad", "KD3005P", "", 1, volts_30, amps_5, 0},
63 {"Korad", "KD6005P", "", 1, volts_60, amps_5, 0},
64 {"RND", "KA3005P", "RND 320-KA3005P", 1, volts_30, amps_5,
65 KORAD_QUIRK_ID_OPT_VERSION},
66 {"RND", "KD3005P", "RND 320-KD3005P", 1, volts_30, amps_5,
67 KORAD_QUIRK_ID_OPT_VERSION},
68 {"Stamos Soldering", "S-LS-31", "", 1, volts_30, amps_5,
69 KORAD_QUIRK_ID_NO_VENDOR},
70 {"Tenma", "72-2535", "", 1, volts_30, amps_3, 0},
71 {"Tenma", "72-2540", "", 1, volts_30, amps_5, 0},
72 {"Tenma", "72-2550", "", 1, volts_60, amps_3, 0},
73 {"Tenma", "72-2705", "", 1, volts_30, amps_3, 0},
74 {"Tenma", "72-2710", "", 1, volts_30, amps_5, 0},
75 {"Velleman", "LABPS3005D", "", 1, volts_30, amps_5,
76 KORAD_QUIRK_LABPS_OVP_EN},
77 {"Velleman", "PS3005D", "", 1, volts_30, amps_5, 0},
82 * Bump this when adding new models[] above. Make sure the text buffer
83 * for the ID response can hold the longest sequence that we expect in
84 * the field which consists of: vendor + model [ + version ][ + serno ].
85 * Don't be too generous here, the maximum receive buffer size affects
86 * the timeout within which the first response character is expected.
88 static const size_t id_text_buffer_size = 48;
91 * Check whether the device's "*IDN?" response matches a supported model.
92 * The caller already stripped off the optional serial number.
94 static gboolean model_matches(const struct korad_kaxxxxp_model *model,
98 gboolean opt_version, skip_vendor, accept_trail;
105 * When the models[] entry contains a specific response text,
106 * then expect to see this very text in literal form. This
107 * lets the driver map weird and untypical responses to a
108 * specific set of display texts for vendor and model names.
109 * Accept an optionally trailing version if models[] says so.
111 if (model->id && model->id[0]) {
112 opt_version = model->quirks & KORAD_QUIRK_ID_OPT_VERSION;
114 matches = g_strcmp0(id_text, model->id) == 0;
117 sr_dbg("Matches expected ID text: '%s'.", model->id);
120 matches = g_str_has_prefix(id_text, model->id);
123 id_text += strlen(model->id);
124 while (isspace((int)*id_text))
126 if (*id_text == 'V') {
128 while (*id_text == '.' || isdigit((int)*id_text))
130 while (isspace((int)*id_text))
135 sr_dbg("Matches expected ID text [vers]: '%s'.", model->id);
140 * A more generic approach which covers most devices: Check
141 * for the very vendor and model names which also are shown
142 * to users (the display texts). Weakened to match responses
143 * more widely: Case insensitive checks, optional whitespace
144 * in responses, optional version details. Optional trailing
145 * garbage. Optional omission of the vendor name. Shall match
146 * all the devices which were individually listed in earlier
147 * implementations of the driver, and shall also match firmware
148 * versions that were not listed before.
150 skip_vendor = model->quirks & KORAD_QUIRK_ID_NO_VENDOR;
151 accept_trail = model->quirks & KORAD_QUIRK_ID_TRAILING;
153 want = model->vendor;
154 matches = g_ascii_strncasecmp(id_text, want, strlen(want)) == 0;
157 id_text += strlen(want);
158 while (isspace((int)*id_text))
162 matches = g_ascii_strncasecmp(id_text, want, strlen(want)) == 0;
165 id_text += strlen(want);
166 while (isspace((int)*id_text))
168 if (*id_text == 'V') {
169 /* TODO Isolate and (also) return version details? */
171 while (*id_text == '.' || isdigit((int)*id_text))
173 while (isspace((int)*id_text))
178 * TODO Determine how many non-printables to accept here
179 * and how strict to check for "known" garbage variants.
195 sr_dbg("Matches generic '[vendor] model [vers] [trail]' pattern.");
199 /* Lookup a model from an ID response text. */
200 static const struct korad_kaxxxxp_model *model_lookup(const char *id_text)
203 const struct korad_kaxxxxp_model *check;
205 if (!id_text || !*id_text)
207 sr_dbg("Looking up: [%s].", id_text);
209 for (idx = 0; idx < ARRAY_SIZE(models); idx++) {
210 check = &models[idx];
211 if (!check->name || !check->name[0])
213 if (!model_matches(check, id_text))
215 sr_dbg("Found: [%s] [%s]", check->vendor, check->name);
223 static GSList *scan(struct sr_dev_driver *di, GSList *options)
225 static const char *serno_prefix = " SN:";
227 struct dev_context *devc;
229 struct sr_dev_inst *sdi;
230 struct sr_config *src;
231 const char *conn, *serialcomm;
232 const char *force_detect;
233 struct sr_serial_dev_inst *serial;
236 const struct korad_kaxxxxp_model *model;
244 for (l = options; l; l = l->next) {
248 conn = g_variant_get_string(src->data, NULL);
250 case SR_CONF_SERIALCOMM:
251 serialcomm = g_variant_get_string(src->data, NULL);
253 case SR_CONF_FORCE_DETECT:
254 force_detect = g_variant_get_string(src->data, NULL);
257 sr_err("Unknown option %d, skipping.", src->key);
265 serialcomm = "9600/8n1";
266 if (force_detect && !*force_detect)
269 serial = sr_serial_dev_inst_new(conn, serialcomm);
270 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
273 /* Communicate the identification request. */
274 len = id_text_buffer_size;
275 if (len > sizeof(reply) - 1)
276 len = sizeof(reply) - 1;
277 sr_dbg("Want max %zu bytes.", len);
279 ret = korad_kaxxxxp_send_cmd(serial, "*IDN?");
283 ret = korad_kaxxxxp_read_chars(serial, len, reply);
286 sr_dbg("Received: %d, %s", ret, reply);
289 * Isolate the optional serial number at the response's end.
290 * Lookup the response's model ID in the list of known models.
292 serno = g_strrstr(reply, serno_prefix);
295 serno += strlen(serno_prefix);
298 model = model_lookup(reply);
299 if (!model && force_detect) {
300 sr_warn("Could not find model ID '%s', trying '%s'.",
301 reply, force_detect);
302 model = model_lookup(force_detect);
304 sr_info("Found replacement, using it instead.");
307 sr_err("Unsupported model ID '%s', aborting.", reply);
310 sr_dbg("Found: %s %s (idx %zu).", model->vendor, model->name,
313 sdi = g_malloc0(sizeof(struct sr_dev_inst));
314 sdi->status = SR_ST_INACTIVE;
315 sdi->vendor = g_strdup(model->vendor);
316 sdi->model = g_strdup(model->name);
318 sdi->serial_num = g_strdup(serno);
319 sdi->inst_type = SR_INST_SERIAL;
321 sdi->connection_id = g_strdup(conn);
323 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
324 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
326 devc = g_malloc0(sizeof(struct dev_context));
327 sr_sw_limits_init(&devc->limits);
328 g_mutex_init(&devc->rw_mutex);
330 devc->req_sent_at = 0;
331 devc->cc_mode_1_changed = FALSE;
332 devc->cc_mode_2_changed = FALSE;
333 devc->output_enabled_changed = FALSE;
334 devc->ocp_enabled_changed = FALSE;
335 devc->ovp_enabled_changed = FALSE;
338 /* Get current status of device. */
339 if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
342 serial_close(serial);
344 return std_scan_complete(di, g_slist_append(NULL, sdi));
347 sr_dev_inst_free(sdi);
349 sr_dbg("Scan failed.");
354 static int config_get(uint32_t key, GVariant **data,
355 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
357 struct dev_context *devc;
367 case SR_CONF_LIMIT_SAMPLES:
368 case SR_CONF_LIMIT_MSEC:
369 return sr_sw_limits_config_get(&devc->limits, key, data);
371 *data = g_variant_new_string(sdi->connection_id);
373 case SR_CONF_VOLTAGE:
374 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
375 *data = g_variant_new_double(devc->voltage);
377 case SR_CONF_VOLTAGE_TARGET:
378 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc);
379 *data = g_variant_new_double(devc->voltage_target);
381 case SR_CONF_CURRENT:
382 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
383 *data = g_variant_new_double(devc->current);
385 case SR_CONF_CURRENT_LIMIT:
386 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc);
387 *data = g_variant_new_double(devc->current_limit);
389 case SR_CONF_ENABLED:
390 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
391 *data = g_variant_new_boolean(devc->output_enabled);
393 case SR_CONF_REGULATION:
394 /* Dual channel not supported. */
395 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
396 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
398 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
399 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
400 *data = g_variant_new_boolean(devc->ocp_enabled);
402 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
403 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
404 *data = g_variant_new_boolean(devc->ovp_enabled);
413 static int config_set(uint32_t key, GVariant *data,
414 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
416 struct dev_context *devc;
425 case SR_CONF_LIMIT_MSEC:
426 case SR_CONF_LIMIT_SAMPLES:
427 return sr_sw_limits_config_set(&devc->limits, key, data);
428 case SR_CONF_VOLTAGE_TARGET:
429 dval = g_variant_get_double(data);
430 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
432 devc->set_voltage_target = dval;
433 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc) < 0)
436 case SR_CONF_CURRENT_LIMIT:
437 dval = g_variant_get_double(data);
438 if (dval < devc->model->current[0] || dval > devc->model->current[1])
440 devc->set_current_limit = dval;
441 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc) < 0)
444 case SR_CONF_ENABLED:
445 bval = g_variant_get_boolean(data);
446 /* Set always so it is possible turn off with sigrok-cli. */
447 devc->set_output_enabled = bval;
448 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
451 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
452 bval = g_variant_get_boolean(data);
453 devc->set_ocp_enabled = bval;
454 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
457 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
458 bval = g_variant_get_boolean(data);
459 devc->set_ovp_enabled = bval;
460 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
470 static int config_list(uint32_t key, GVariant **data,
471 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
473 struct dev_context *devc;
475 devc = (sdi) ? sdi->priv : NULL;
478 case SR_CONF_SCAN_OPTIONS:
479 case SR_CONF_DEVICE_OPTIONS:
480 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
481 case SR_CONF_VOLTAGE_TARGET:
482 if (!devc || !devc->model)
484 *data = std_gvar_min_max_step_array(devc->model->voltage);
486 case SR_CONF_CURRENT_LIMIT:
487 if (!devc || !devc->model)
489 *data = std_gvar_min_max_step_array(devc->model->current);
498 static int dev_close(struct sr_dev_inst *sdi)
500 struct dev_context *devc;
502 devc = (sdi) ? sdi->priv : NULL;
504 g_mutex_clear(&devc->rw_mutex);
506 return std_serial_dev_close(sdi);
509 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
511 struct dev_context *devc;
512 struct sr_serial_dev_inst *serial;
516 sr_sw_limits_acquisition_start(&devc->limits);
517 std_session_send_df_header(sdi);
519 devc->req_sent_at = 0;
521 serial_source_add(sdi->session, serial, G_IO_IN,
522 KAXXXXP_POLL_INTERVAL_MS,
523 korad_kaxxxxp_receive_data, (void *)sdi);
528 static struct sr_dev_driver korad_kaxxxxp_driver_info = {
529 .name = "korad-kaxxxxp",
530 .longname = "Korad KAxxxxP",
533 .cleanup = std_cleanup,
535 .dev_list = std_dev_list,
536 .dev_clear = std_dev_clear,
537 .config_get = config_get,
538 .config_set = config_set,
539 .config_list = config_list,
540 .dev_open = std_serial_dev_open,
541 .dev_close = dev_close,
542 .dev_acquisition_start = dev_acquisition_start,
543 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
546 SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);