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