]> sigrok.org Git - libsigrok.git/blame - src/hardware/korad-kaxxxxp/api.c
korad-kaxxxxp: Send META packet when states have changed.
[libsigrok.git] / src / hardware / korad-kaxxxxp / api.c
CommitLineData
e75ee7de
HV
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2015 Hannu Vuolasaho <vuokkosetae@gmail.com>
2e129b8b 5 * Copyright (C) 2018-2019 Frank Stettner <frank-stettner@gmx.net>
e75ee7de
HV
6 *
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.
11 *
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.
16 *
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/>.
19 */
20
21#include <config.h>
22#include "protocol.h"
23
d7083042
HV
24static const uint32_t scanopts[] = {
25 SR_CONF_CONN,
26 SR_CONF_SERIALCOMM,
27};
28
55fb76b3 29static const uint32_t drvopts[] = {
55fb76b3
UH
30 SR_CONF_POWER_SUPPLY,
31};
32
d7083042 33static const uint32_t devopts[] = {
d7083042
HV
34 SR_CONF_CONTINUOUS,
35 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
36 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
d7083042
HV
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,
b16d975a 42 SR_CONF_REGULATION | SR_CONF_GET,
c40ed60f
HV
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,
d7083042
HV
45};
46
16fc7ee2 47static const struct korad_kaxxxxp_model models[] = {
d7083042 48 /* Device enum, vendor, model, ID reply, channels, voltage, current */
ae9ca5b1
UH
49 {VELLEMAN_PS3005D, "Velleman", "PS3005D",
50 "VELLEMANPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
51 {VELLEMAN_LABPS3005D, "Velleman", "LABPS3005D",
d7083042 52 "VELLEMANLABPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
bcf9384d 53 {KORAD_KA3005P, "Korad", "KA3005P",
2c5bdf1b 54 "KORADKA3005PV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
a078d3ec
UH
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}},
1c0e1baa
FS
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}},
41802ca4
HM
61 {KORAD_KD3005P, "Korad", "KD3005P",
62 "KORAD KD3005P V2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
76f712a7
GS
63 {KORAD_KD3005P_V20_NOSP, "Korad", "KD3005P",
64 "KORADKD3005PV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
e843992d
AH
65 {RND_320K30PV, "RND", "KA3005P",
66 "RND 320-KA3005P V2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
0540954d
UH
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}},
ddbe6880
DA
71 {TENMA_72_2535_V21, "Tenma", "72-2535",
72 "TENMA 72-2535 V2.1", 1, {0, 31, 0.01}, {0, 3, 0.001}},
27a9b663
TA
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}},
b1b8a7d0
EE
75 {KORAD_KD6005P, "Korad", "KD6005P",
76 "KORAD KD6005P V2.2", 1, {0, 61, 0.01}, {0, 5, 0.001}},
9e9dba7b 77 ALL_ZERO
d7083042
HV
78};
79
e75ee7de
HV
80static GSList *scan(struct sr_dev_driver *di, GSList *options)
81{
d7083042 82 struct dev_context *devc;
43376f33 83 GSList *l;
d7083042
HV
84 struct sr_dev_inst *sdi;
85 struct sr_config *src;
86 const char *conn, *serialcomm;
87 struct sr_serial_dev_inst *serial;
88 char reply[50];
89 int i, model_id;
90 unsigned int len;
e75ee7de 91
d7083042
HV
92 conn = NULL;
93 serialcomm = NULL;
e75ee7de 94
d7083042
HV
95 for (l = options; l; l = l->next) {
96 src = l->data;
97 switch (src->key) {
98 case SR_CONF_CONN:
99 conn = g_variant_get_string(src->data, NULL);
100 break;
101 case SR_CONF_SERIALCOMM:
102 serialcomm = g_variant_get_string(src->data, NULL);
103 break;
104 default:
105 sr_err("Unknown option %d, skipping.", src->key);
106 break;
107 }
108 }
109
110 if (!conn)
111 return NULL;
112 if (!serialcomm)
113 serialcomm = "9600/8n1";
114
115 serial = sr_serial_dev_inst_new(conn, serialcomm);
116 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
117 return NULL;
118
119 serial_flush(serial);
120
121 /* Get the device model. */
122 len = 0;
123 for (i = 0; models[i].id; i++) {
124 if (strlen(models[i].id) > len)
125 len = strlen(models[i].id);
126 }
127 memset(&reply, 0, sizeof(reply));
128 sr_dbg("Want max %d bytes.", len);
16fc7ee2 129 if ((korad_kaxxxxp_send_cmd(serial, "*IDN?") < 0))
d7083042
HV
130 return NULL;
131
132 /* i is used here for debug purposes only. */
16fc7ee2 133 if ((i = korad_kaxxxxp_read_chars(serial, len, reply)) < 0)
d7083042
HV
134 return NULL;
135 sr_dbg("Received: %d, %s", i, reply);
136 model_id = -1;
137 for (i = 0; models[i].id; i++) {
1c0e1baa 138 if (!g_strcmp0(models[i].id, reply))
d7083042
HV
139 model_id = i;
140 }
141 if (model_id < 0) {
142 sr_err("Unknown model ID '%s' detected, aborting.", reply);
143 return NULL;
144 }
a078d3ec
UH
145 sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor,
146 models[model_id].name, model_id, models[model_id].id);
d7083042 147
d7083042
HV
148 sdi = g_malloc0(sizeof(struct sr_dev_inst));
149 sdi->status = SR_ST_INACTIVE;
150 sdi->vendor = g_strdup(models[model_id].vendor);
151 sdi->model = g_strdup(models[model_id].name);
152 sdi->inst_type = SR_INST_SERIAL;
153 sdi->conn = serial;
d7083042 154
23165d7b
FS
155 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
156 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
d7083042
HV
157
158 devc = g_malloc0(sizeof(struct dev_context));
597deef9 159 sr_sw_limits_init(&devc->limits);
3f9b48ae 160 g_mutex_init(&devc->rw_mutex);
d7083042 161 devc->model = &models[model_id];
d7083042 162 devc->req_sent_at = 0;
2e129b8b
FS
163 devc->cc_mode_1_changed = FALSE;
164 devc->cc_mode_2_changed = FALSE;
165 devc->output_enabled_changed = FALSE;
166 devc->ocp_enabled_changed = FALSE;
167 devc->ovp_enabled_changed = FALSE;
d7083042
HV
168 sdi->priv = devc;
169
170 /* Get current status of device. */
16fc7ee2 171 if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
d7083042 172 goto exit_err;
d7083042
HV
173
174 serial_close(serial);
e75ee7de 175
43376f33 176 return std_scan_complete(di, g_slist_append(NULL, sdi));
d7083042
HV
177
178exit_err:
179 sr_dev_inst_free(sdi);
180 g_free(devc);
181 sr_dbg("Scan failed.");
182
183 return NULL;
e75ee7de
HV
184}
185
e75ee7de
HV
186static int config_get(uint32_t key, GVariant **data,
187 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
188{
d7083042 189 struct dev_context *devc;
e75ee7de 190
e75ee7de
HV
191 (void)cg;
192
d7083042
HV
193 if (!sdi || !data)
194 return SR_ERR_ARG;
195
196 devc = sdi->priv;
197
e75ee7de 198 switch (key) {
cd04f641
UH
199 case SR_CONF_LIMIT_SAMPLES:
200 case SR_CONF_LIMIT_MSEC:
597deef9 201 return sr_sw_limits_config_get(&devc->limits, key, data);
d7083042 202 case SR_CONF_VOLTAGE:
3f9b48ae 203 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
d7083042
HV
204 *data = g_variant_new_double(devc->voltage);
205 break;
206 case SR_CONF_VOLTAGE_TARGET:
8da30037
FS
207 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc);
208 *data = g_variant_new_double(devc->voltage_target);
d7083042
HV
209 break;
210 case SR_CONF_CURRENT:
3f9b48ae 211 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
d7083042
HV
212 *data = g_variant_new_double(devc->current);
213 break;
214 case SR_CONF_CURRENT_LIMIT:
8da30037
FS
215 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc);
216 *data = g_variant_new_double(devc->current_limit);
d7083042
HV
217 break;
218 case SR_CONF_ENABLED:
3f9b48ae 219 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
d7083042
HV
220 *data = g_variant_new_boolean(devc->output_enabled);
221 break;
b16d975a
HV
222 case SR_CONF_REGULATION:
223 /* Dual channel not supported. */
3f9b48ae 224 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
9e5366df 225 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
b16d975a 226 break;
c40ed60f 227 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
3f9b48ae 228 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
9e5366df 229 *data = g_variant_new_boolean(devc->ocp_enabled);
c40ed60f
HV
230 break;
231 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
3f9b48ae 232 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
9e5366df 233 *data = g_variant_new_boolean(devc->ovp_enabled);
c40ed60f 234 break;
e75ee7de
HV
235 default:
236 return SR_ERR_NA;
237 }
238
d7083042 239 return SR_OK;
e75ee7de
HV
240}
241
242static int config_set(uint32_t key, GVariant *data,
243 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
244{
d7083042
HV
245 struct dev_context *devc;
246 double dval;
247 gboolean bval;
e75ee7de 248
e75ee7de
HV
249 (void)cg;
250
d7083042
HV
251 devc = sdi->priv;
252
e75ee7de 253 switch (key) {
d7083042 254 case SR_CONF_LIMIT_MSEC:
d7083042 255 case SR_CONF_LIMIT_SAMPLES:
597deef9 256 return sr_sw_limits_config_set(&devc->limits, key, data);
d7083042
HV
257 case SR_CONF_VOLTAGE_TARGET:
258 dval = g_variant_get_double(data);
259 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
260 return SR_ERR_ARG;
8da30037
FS
261 devc->set_voltage_target = dval;
262 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc) < 0)
d7083042
HV
263 return SR_ERR;
264 break;
265 case SR_CONF_CURRENT_LIMIT:
266 dval = g_variant_get_double(data);
267 if (dval < devc->model->current[0] || dval > devc->model->current[1])
268 return SR_ERR_ARG;
8da30037
FS
269 devc->set_current_limit = dval;
270 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc) < 0)
d7083042
HV
271 return SR_ERR;
272 break;
273 case SR_CONF_ENABLED:
274 bval = g_variant_get_boolean(data);
275 /* Set always so it is possible turn off with sigrok-cli. */
8da30037 276 devc->set_output_enabled = bval;
3f9b48ae 277 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
d7083042 278 return SR_ERR;
c40ed60f
HV
279 break;
280 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
281 bval = g_variant_get_boolean(data);
8da30037 282 devc->set_ocp_enabled = bval;
3f9b48ae 283 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
c40ed60f
HV
284 return SR_ERR;
285 break;
286 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
287 bval = g_variant_get_boolean(data);
8da30037 288 devc->set_ovp_enabled = bval;
3f9b48ae 289 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
c40ed60f 290 return SR_ERR;
d7083042 291 break;
e75ee7de 292 default:
d7083042 293 return SR_ERR_NA;
e75ee7de
HV
294 }
295
d7083042 296 return SR_OK;
e75ee7de
HV
297}
298
299static int config_list(uint32_t key, GVariant **data,
300 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
301{
d7083042 302 struct dev_context *devc;
d7083042 303
e66d1892 304 devc = (sdi) ? sdi->priv : NULL;
d7083042 305
e75ee7de 306 switch (key) {
e66d1892 307 case SR_CONF_SCAN_OPTIONS:
d7083042 308 case SR_CONF_DEVICE_OPTIONS:
e66d1892 309 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
d7083042 310 case SR_CONF_VOLTAGE_TARGET:
fc69eecc
GS
311 if (!devc || !devc->model)
312 return SR_ERR_ARG;
54d471f4 313 *data = std_gvar_min_max_step_array(devc->model->voltage);
d7083042
HV
314 break;
315 case SR_CONF_CURRENT_LIMIT:
fc69eecc
GS
316 if (!devc || !devc->model)
317 return SR_ERR_ARG;
54d471f4 318 *data = std_gvar_min_max_step_array(devc->model->current);
d7083042 319 break;
e75ee7de
HV
320 default:
321 return SR_ERR_NA;
322 }
323
d7083042 324 return SR_OK;
e75ee7de
HV
325}
326
3f9b48ae
FS
327static int dev_close(struct sr_dev_inst *sdi)
328{
329 struct dev_context *devc;
330
331 devc = (sdi) ? sdi->priv : NULL;
332 if (devc)
333 g_mutex_clear(&devc->rw_mutex);
334
335 return std_serial_dev_close(sdi);
336}
337
695dc859 338static int dev_acquisition_start(const struct sr_dev_inst *sdi)
e75ee7de 339{
d7083042
HV
340 struct dev_context *devc;
341 struct sr_serial_dev_inst *serial;
e75ee7de 342
d7083042 343 devc = sdi->priv;
d7083042 344
597deef9 345 sr_sw_limits_acquisition_start(&devc->limits);
bee2b016 346 std_session_send_df_header(sdi);
d7083042 347
d7083042
HV
348 devc->req_sent_at = 0;
349 serial = sdi->conn;
350 serial_source_add(sdi->session, serial, G_IO_IN,
16fc7ee2
UH
351 KAXXXXP_POLL_INTERVAL_MS,
352 korad_kaxxxxp_receive_data, (void *)sdi);
e75ee7de
HV
353
354 return SR_OK;
355}
356
dd5c48a6 357static struct sr_dev_driver korad_kaxxxxp_driver_info = {
16fc7ee2
UH
358 .name = "korad-kaxxxxp",
359 .longname = "Korad KAxxxxP",
e75ee7de 360 .api_version = 1,
c2fdcc25 361 .init = std_init,
700d6b64 362 .cleanup = std_cleanup,
e75ee7de 363 .scan = scan,
c01bf34c 364 .dev_list = std_dev_list,
f778bf02 365 .dev_clear = std_dev_clear,
e75ee7de
HV
366 .config_get = config_get,
367 .config_set = config_set,
368 .config_list = config_list,
d7083042 369 .dev_open = std_serial_dev_open,
3f9b48ae 370 .dev_close = dev_close,
e75ee7de 371 .dev_acquisition_start = dev_acquisition_start,
4b1a9d5d 372 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
e75ee7de
HV
373 .context = NULL,
374};
dd5c48a6 375SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);