2 * This file is part of the libsigrok project.
4 * Copyright (C) 2015 Hannu Vuolasaho <vuokkosetae@gmail.com>
5 * Copyright (C) 2018 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[] = {
35 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
36 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
37 SR_CONF_VOLTAGE | SR_CONF_GET,
38 SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
39 SR_CONF_CURRENT | SR_CONF_GET,
40 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
41 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
42 SR_CONF_REGULATION | SR_CONF_GET,
43 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
44 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
47 static const struct korad_kaxxxxp_model models[] = {
48 /* Device enum, vendor, model, ID reply, channels, voltage, current */
49 {VELLEMAN_PS3005D, "Velleman", "PS3005D",
50 "VELLEMANPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
51 {VELLEMAN_LABPS3005D, "Velleman", "LABPS3005D",
52 "VELLEMANLABPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
53 {KORAD_KA3005P, "Korad", "KA3005P",
54 "KORADKA3005PV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
55 /* Sometimes the KA3005P has an extra 0x01 after the ID. */
56 {KORAD_KA3005P_0X01, "Korad", "KA3005P",
57 "KORADKA3005PV2.0\x01", 1, {0, 31, 0.01}, {0, 5, 0.001}},
58 /* Sometimes the KA3005P has an extra 0xBC after the ID. */
59 {KORAD_KA3005P_0XBC, "Korad", "KA3005P",
60 "KORADKA3005PV2.0\xBC", 1, {0, 31, 0.01}, {0, 5, 0.001}},
61 {KORAD_KD3005P, "Korad", "KD3005P",
62 "KORAD KD3005P V2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
63 {KORAD_KD3005P_V20_NOSP, "Korad", "KD3005P",
64 "KORADKD3005PV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
65 {RND_320K30PV, "RND", "KA3005P",
66 "RND 320-KA3005P V2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
67 {TENMA_72_2540_V20, "Tenma", "72-2540",
68 "TENMA72-2540V2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
69 {TENMA_72_2540_V21, "Tenma", "72-2540",
70 "TENMA 72-2540 V2.1", 1, {0, 31, 0.01}, {0, 5, 0.001}},
71 {TENMA_72_2535_V21, "Tenma", "72-2535",
72 "TENMA 72-2535 V2.1", 1, {0, 31, 0.01}, {0, 3, 0.001}},
73 {STAMOS_SLS31_V20, "Stamos Soldering", "S-LS-31",
74 "S-LS-31 V2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
78 static GSList *scan(struct sr_dev_driver *di, GSList *options)
80 struct dev_context *devc;
82 struct sr_dev_inst *sdi;
83 struct sr_config *src;
84 const char *conn, *serialcomm;
85 struct sr_serial_dev_inst *serial;
93 for (l = options; l; l = l->next) {
97 conn = g_variant_get_string(src->data, NULL);
99 case SR_CONF_SERIALCOMM:
100 serialcomm = g_variant_get_string(src->data, NULL);
103 sr_err("Unknown option %d, skipping.", src->key);
111 serialcomm = "9600/8n1";
113 serial = sr_serial_dev_inst_new(conn, serialcomm);
114 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
117 serial_flush(serial);
119 /* Get the device model. */
121 for (i = 0; models[i].id; i++) {
122 if (strlen(models[i].id) > len)
123 len = strlen(models[i].id);
125 memset(&reply, 0, sizeof(reply));
126 sr_dbg("Want max %d bytes.", len);
127 if ((korad_kaxxxxp_send_cmd(serial, "*IDN?") < 0))
130 /* i is used here for debug purposes only. */
131 if ((i = korad_kaxxxxp_read_chars(serial, len, reply)) < 0)
133 sr_dbg("Received: %d, %s", i, reply);
135 for (i = 0; models[i].id; i++) {
136 if (!g_strcmp0(models[i].id, reply))
140 sr_err("Unknown model ID '%s' detected, aborting.", reply);
143 sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor,
144 models[model_id].name, model_id, models[model_id].id);
146 sdi = g_malloc0(sizeof(struct sr_dev_inst));
147 sdi->status = SR_ST_INACTIVE;
148 sdi->vendor = g_strdup(models[model_id].vendor);
149 sdi->model = g_strdup(models[model_id].name);
150 sdi->inst_type = SR_INST_SERIAL;
153 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
154 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
156 devc = g_malloc0(sizeof(struct dev_context));
157 sr_sw_limits_init(&devc->limits);
158 g_mutex_init(&devc->rw_mutex);
159 devc->model = &models[model_id];
160 devc->req_sent_at = 0;
163 /* Get current status of device. */
164 if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
167 serial_close(serial);
169 return std_scan_complete(di, g_slist_append(NULL, sdi));
172 sr_dev_inst_free(sdi);
174 sr_dbg("Scan failed.");
179 static int config_get(uint32_t key, GVariant **data,
180 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
182 struct dev_context *devc;
192 case SR_CONF_LIMIT_SAMPLES:
193 case SR_CONF_LIMIT_MSEC:
194 return sr_sw_limits_config_get(&devc->limits, key, data);
195 case SR_CONF_VOLTAGE:
196 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
197 *data = g_variant_new_double(devc->voltage);
199 case SR_CONF_VOLTAGE_TARGET:
200 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_MAX, devc);
201 *data = g_variant_new_double(devc->voltage_max);
203 case SR_CONF_CURRENT:
204 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
205 *data = g_variant_new_double(devc->current);
207 case SR_CONF_CURRENT_LIMIT:
208 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_MAX, devc);
209 *data = g_variant_new_double(devc->current_max);
211 case SR_CONF_ENABLED:
212 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
213 *data = g_variant_new_boolean(devc->output_enabled);
215 case SR_CONF_REGULATION:
216 /* Dual channel not supported. */
217 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
218 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
220 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
221 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
222 *data = g_variant_new_boolean(devc->ocp_enabled);
224 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
225 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
226 *data = g_variant_new_boolean(devc->ovp_enabled);
235 static int config_set(uint32_t key, GVariant *data,
236 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
238 struct dev_context *devc;
247 case SR_CONF_LIMIT_MSEC:
248 case SR_CONF_LIMIT_SAMPLES:
249 return sr_sw_limits_config_set(&devc->limits, key, data);
250 case SR_CONF_VOLTAGE_TARGET:
251 dval = g_variant_get_double(data);
252 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
254 devc->voltage_max = dval;
255 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_MAX, devc) < 0)
258 case SR_CONF_CURRENT_LIMIT:
259 dval = g_variant_get_double(data);
260 if (dval < devc->model->current[0] || dval > devc->model->current[1])
262 devc->current_max = dval;
263 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_MAX, devc) < 0)
266 case SR_CONF_ENABLED:
267 bval = g_variant_get_boolean(data);
268 /* Set always so it is possible turn off with sigrok-cli. */
269 devc->output_enabled = bval;
270 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
273 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
274 bval = g_variant_get_boolean(data);
275 devc->ocp_enabled = bval;
276 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
279 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
280 bval = g_variant_get_boolean(data);
281 devc->ovp_enabled = bval;
282 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
292 static int config_list(uint32_t key, GVariant **data,
293 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
295 struct dev_context *devc;
297 devc = (sdi) ? sdi->priv : NULL;
300 case SR_CONF_SCAN_OPTIONS:
301 case SR_CONF_DEVICE_OPTIONS:
302 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
303 case SR_CONF_VOLTAGE_TARGET:
304 if (!devc || !devc->model)
306 *data = std_gvar_min_max_step_array(devc->model->voltage);
308 case SR_CONF_CURRENT_LIMIT:
309 if (!devc || !devc->model)
311 *data = std_gvar_min_max_step_array(devc->model->current);
320 static int dev_close(struct sr_dev_inst *sdi)
322 struct dev_context *devc;
324 devc = (sdi) ? sdi->priv : NULL;
326 g_mutex_clear(&devc->rw_mutex);
328 return std_serial_dev_close(sdi);
331 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
333 struct dev_context *devc;
334 struct sr_serial_dev_inst *serial;
338 sr_sw_limits_acquisition_start(&devc->limits);
339 std_session_send_df_header(sdi);
341 devc->req_sent_at = 0;
343 serial_source_add(sdi->session, serial, G_IO_IN,
344 KAXXXXP_POLL_INTERVAL_MS,
345 korad_kaxxxxp_receive_data, (void *)sdi);
350 static struct sr_dev_driver korad_kaxxxxp_driver_info = {
351 .name = "korad-kaxxxxp",
352 .longname = "Korad KAxxxxP",
355 .cleanup = std_cleanup,
357 .dev_list = std_dev_list,
358 .dev_clear = std_dev_clear,
359 .config_get = config_get,
360 .config_set = config_set,
361 .config_list = config_list,
362 .dev_open = std_serial_dev_open,
363 .dev_close = dev_close,
364 .dev_acquisition_start = dev_acquisition_start,
365 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
368 SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);