]> sigrok.org Git - libsigrok.git/blame - src/hardware/korad-kaxxxxp/api.c
korad-kaxxxxp: Synchronize read and write operations.
[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>
3f9b48ae 5 * Copyright (C) 2018 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}},
41802ca4
HM
58 {KORAD_KD3005P, "Korad", "KD3005P",
59 "KORAD KD3005P V2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
9e9dba7b 60 ALL_ZERO
d7083042
HV
61};
62
e75ee7de
HV
63static GSList *scan(struct sr_dev_driver *di, GSList *options)
64{
d7083042 65 struct dev_context *devc;
43376f33 66 GSList *l;
d7083042
HV
67 struct sr_dev_inst *sdi;
68 struct sr_config *src;
69 const char *conn, *serialcomm;
70 struct sr_serial_dev_inst *serial;
71 char reply[50];
72 int i, model_id;
73 unsigned int len;
e75ee7de 74
d7083042
HV
75 conn = NULL;
76 serialcomm = NULL;
e75ee7de 77
d7083042
HV
78 for (l = options; l; l = l->next) {
79 src = l->data;
80 switch (src->key) {
81 case SR_CONF_CONN:
82 conn = g_variant_get_string(src->data, NULL);
83 break;
84 case SR_CONF_SERIALCOMM:
85 serialcomm = g_variant_get_string(src->data, NULL);
86 break;
87 default:
88 sr_err("Unknown option %d, skipping.", src->key);
89 break;
90 }
91 }
92
93 if (!conn)
94 return NULL;
95 if (!serialcomm)
96 serialcomm = "9600/8n1";
97
98 serial = sr_serial_dev_inst_new(conn, serialcomm);
99 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
100 return NULL;
101
102 serial_flush(serial);
103
104 /* Get the device model. */
105 len = 0;
106 for (i = 0; models[i].id; i++) {
107 if (strlen(models[i].id) > len)
108 len = strlen(models[i].id);
109 }
110 memset(&reply, 0, sizeof(reply));
111 sr_dbg("Want max %d bytes.", len);
16fc7ee2 112 if ((korad_kaxxxxp_send_cmd(serial, "*IDN?") < 0))
d7083042
HV
113 return NULL;
114
115 /* i is used here for debug purposes only. */
16fc7ee2 116 if ((i = korad_kaxxxxp_read_chars(serial, len, reply)) < 0)
d7083042
HV
117 return NULL;
118 sr_dbg("Received: %d, %s", i, reply);
119 model_id = -1;
120 for (i = 0; models[i].id; i++) {
121 if (!strcmp(models[i].id, reply))
122 model_id = i;
123 }
124 if (model_id < 0) {
125 sr_err("Unknown model ID '%s' detected, aborting.", reply);
126 return NULL;
127 }
a078d3ec
UH
128 sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor,
129 models[model_id].name, model_id, models[model_id].id);
d7083042 130
d7083042
HV
131 sdi = g_malloc0(sizeof(struct sr_dev_inst));
132 sdi->status = SR_ST_INACTIVE;
133 sdi->vendor = g_strdup(models[model_id].vendor);
134 sdi->model = g_strdup(models[model_id].name);
135 sdi->inst_type = SR_INST_SERIAL;
136 sdi->conn = serial;
d7083042 137
23165d7b
FS
138 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
139 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
d7083042
HV
140
141 devc = g_malloc0(sizeof(struct dev_context));
597deef9 142 sr_sw_limits_init(&devc->limits);
3f9b48ae 143 g_mutex_init(&devc->rw_mutex);
d7083042 144 devc->model = &models[model_id];
d7083042
HV
145 devc->req_sent_at = 0;
146 sdi->priv = devc;
147
148 /* Get current status of device. */
16fc7ee2 149 if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
d7083042 150 goto exit_err;
d7083042
HV
151
152 serial_close(serial);
e75ee7de 153
43376f33 154 return std_scan_complete(di, g_slist_append(NULL, sdi));
d7083042
HV
155
156exit_err:
157 sr_dev_inst_free(sdi);
158 g_free(devc);
159 sr_dbg("Scan failed.");
160
161 return NULL;
e75ee7de
HV
162}
163
e75ee7de
HV
164static int config_get(uint32_t key, GVariant **data,
165 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
166{
d7083042 167 struct dev_context *devc;
e75ee7de 168
e75ee7de
HV
169 (void)cg;
170
d7083042
HV
171 if (!sdi || !data)
172 return SR_ERR_ARG;
173
174 devc = sdi->priv;
175
e75ee7de 176 switch (key) {
cd04f641
UH
177 case SR_CONF_LIMIT_SAMPLES:
178 case SR_CONF_LIMIT_MSEC:
597deef9 179 return sr_sw_limits_config_get(&devc->limits, key, data);
d7083042 180 case SR_CONF_VOLTAGE:
3f9b48ae 181 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
d7083042
HV
182 *data = g_variant_new_double(devc->voltage);
183 break;
184 case SR_CONF_VOLTAGE_TARGET:
3f9b48ae 185 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_MAX, devc);
d7083042
HV
186 *data = g_variant_new_double(devc->voltage_max);
187 break;
188 case SR_CONF_CURRENT:
3f9b48ae 189 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
d7083042
HV
190 *data = g_variant_new_double(devc->current);
191 break;
192 case SR_CONF_CURRENT_LIMIT:
3f9b48ae 193 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_MAX, devc);
d7083042
HV
194 *data = g_variant_new_double(devc->current_max);
195 break;
196 case SR_CONF_ENABLED:
3f9b48ae 197 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
d7083042
HV
198 *data = g_variant_new_boolean(devc->output_enabled);
199 break;
b16d975a
HV
200 case SR_CONF_REGULATION:
201 /* Dual channel not supported. */
3f9b48ae 202 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
9e5366df 203 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
b16d975a 204 break;
c40ed60f 205 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
3f9b48ae 206 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
9e5366df 207 *data = g_variant_new_boolean(devc->ocp_enabled);
c40ed60f
HV
208 break;
209 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
3f9b48ae 210 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
9e5366df 211 *data = g_variant_new_boolean(devc->ovp_enabled);
c40ed60f 212 break;
e75ee7de
HV
213 default:
214 return SR_ERR_NA;
215 }
216
d7083042 217 return SR_OK;
e75ee7de
HV
218}
219
220static int config_set(uint32_t key, GVariant *data,
221 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
222{
d7083042
HV
223 struct dev_context *devc;
224 double dval;
225 gboolean bval;
e75ee7de 226
e75ee7de
HV
227 (void)cg;
228
d7083042
HV
229 devc = sdi->priv;
230
e75ee7de 231 switch (key) {
d7083042 232 case SR_CONF_LIMIT_MSEC:
d7083042 233 case SR_CONF_LIMIT_SAMPLES:
597deef9 234 return sr_sw_limits_config_set(&devc->limits, key, data);
d7083042
HV
235 case SR_CONF_VOLTAGE_TARGET:
236 dval = g_variant_get_double(data);
237 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
238 return SR_ERR_ARG;
239 devc->voltage_max = dval;
3f9b48ae 240 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_MAX, devc) < 0)
d7083042
HV
241 return SR_ERR;
242 break;
243 case SR_CONF_CURRENT_LIMIT:
244 dval = g_variant_get_double(data);
245 if (dval < devc->model->current[0] || dval > devc->model->current[1])
246 return SR_ERR_ARG;
247 devc->current_max = dval;
3f9b48ae 248 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_MAX, devc) < 0)
d7083042
HV
249 return SR_ERR;
250 break;
251 case SR_CONF_ENABLED:
252 bval = g_variant_get_boolean(data);
253 /* Set always so it is possible turn off with sigrok-cli. */
254 devc->output_enabled = bval;
3f9b48ae 255 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
d7083042 256 return SR_ERR;
c40ed60f
HV
257 break;
258 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
259 bval = g_variant_get_boolean(data);
9e5366df 260 devc->ocp_enabled = bval;
3f9b48ae 261 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
c40ed60f
HV
262 return SR_ERR;
263 break;
264 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
265 bval = g_variant_get_boolean(data);
9e5366df 266 devc->ovp_enabled = bval;
3f9b48ae 267 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
c40ed60f 268 return SR_ERR;
d7083042 269 break;
e75ee7de 270 default:
d7083042 271 return SR_ERR_NA;
e75ee7de
HV
272 }
273
d7083042 274 return SR_OK;
e75ee7de
HV
275}
276
277static int config_list(uint32_t key, GVariant **data,
278 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
279{
d7083042 280 struct dev_context *devc;
d7083042 281
e66d1892 282 devc = (sdi) ? sdi->priv : NULL;
d7083042 283
e75ee7de 284 switch (key) {
e66d1892 285 case SR_CONF_SCAN_OPTIONS:
d7083042 286 case SR_CONF_DEVICE_OPTIONS:
e66d1892 287 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
d7083042 288 case SR_CONF_VOLTAGE_TARGET:
fc69eecc
GS
289 if (!devc || !devc->model)
290 return SR_ERR_ARG;
54d471f4 291 *data = std_gvar_min_max_step_array(devc->model->voltage);
d7083042
HV
292 break;
293 case SR_CONF_CURRENT_LIMIT:
fc69eecc
GS
294 if (!devc || !devc->model)
295 return SR_ERR_ARG;
54d471f4 296 *data = std_gvar_min_max_step_array(devc->model->current);
d7083042 297 break;
e75ee7de
HV
298 default:
299 return SR_ERR_NA;
300 }
301
d7083042 302 return SR_OK;
e75ee7de
HV
303}
304
3f9b48ae
FS
305static int dev_close(struct sr_dev_inst *sdi)
306{
307 struct dev_context *devc;
308
309 devc = (sdi) ? sdi->priv : NULL;
310 if (devc)
311 g_mutex_clear(&devc->rw_mutex);
312
313 return std_serial_dev_close(sdi);
314}
315
695dc859 316static int dev_acquisition_start(const struct sr_dev_inst *sdi)
e75ee7de 317{
d7083042
HV
318 struct dev_context *devc;
319 struct sr_serial_dev_inst *serial;
e75ee7de 320
d7083042 321 devc = sdi->priv;
d7083042 322
597deef9 323 sr_sw_limits_acquisition_start(&devc->limits);
bee2b016 324 std_session_send_df_header(sdi);
d7083042 325
d7083042
HV
326 devc->req_sent_at = 0;
327 serial = sdi->conn;
328 serial_source_add(sdi->session, serial, G_IO_IN,
16fc7ee2
UH
329 KAXXXXP_POLL_INTERVAL_MS,
330 korad_kaxxxxp_receive_data, (void *)sdi);
e75ee7de
HV
331
332 return SR_OK;
333}
334
dd5c48a6 335static struct sr_dev_driver korad_kaxxxxp_driver_info = {
16fc7ee2
UH
336 .name = "korad-kaxxxxp",
337 .longname = "Korad KAxxxxP",
e75ee7de 338 .api_version = 1,
c2fdcc25 339 .init = std_init,
700d6b64 340 .cleanup = std_cleanup,
e75ee7de 341 .scan = scan,
c01bf34c 342 .dev_list = std_dev_list,
f778bf02 343 .dev_clear = std_dev_clear,
e75ee7de
HV
344 .config_get = config_get,
345 .config_set = config_set,
346 .config_list = config_list,
d7083042 347 .dev_open = std_serial_dev_open,
3f9b48ae 348 .dev_close = dev_close,
e75ee7de 349 .dev_acquisition_start = dev_acquisition_start,
4b1a9d5d 350 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
e75ee7de
HV
351 .context = NULL,
352};
dd5c48a6 353SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);