]> sigrok.org Git - libsigrok.git/blame - src/hardware/korad-kaxxxxp/protocol.c
korad-kaxxxxp: Send META packet when states have changed.
[libsigrok.git] / src / hardware / korad-kaxxxxp / protocol.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
24#define REQ_TIMEOUT_MS 500
25#define DEVICE_PROCESSING_TIME_MS 80
26
16fc7ee2 27SR_PRIV int korad_kaxxxxp_send_cmd(struct sr_serial_dev_inst *serial,
d7083042
HV
28 const char *cmd)
29{
30 int ret;
31
32 sr_dbg("Sending '%s'.", cmd);
33 if ((ret = serial_write_blocking(serial, cmd, strlen(cmd), 0)) < 0) {
34 sr_err("Error sending command: %d.", ret);
35 return ret;
36 }
37
38 return ret;
39}
40
16fc7ee2 41SR_PRIV int korad_kaxxxxp_read_chars(struct sr_serial_dev_inst *serial,
d7083042
HV
42 int count, char *buf)
43{
44 int ret, received, turns;
45
46 received = 0;
47 turns = 0;
48
49 do {
50 if ((ret = serial_read_blocking(serial, buf + received,
51 count - received,
52 serial_timeout(serial, count))) < 0) {
53 sr_err("Error %d reading %d bytes from device.",
54 ret, count);
55 return ret;
56 }
57 received += ret;
58 turns++;
59 } while ((received < count) && (turns < 100));
60
61 buf[count] = 0;
62
63 sr_spew("Received: '%s'.", buf);
64
65 return ret;
66}
67
68static void give_device_time_to_process(struct dev_context *devc)
69{
70 int64_t sleeping_time;
71
72 sleeping_time = devc->req_sent_at + (DEVICE_PROCESSING_TIME_MS * 1000);
73 sleeping_time -= g_get_monotonic_time();
74
75 if (sleeping_time > 0) {
76 g_usleep(sleeping_time);
ef2bcf11 77 sr_spew("Sleeping for processing %" PRIi64 " usec", sleeping_time);
d7083042
HV
78 }
79}
80
16fc7ee2 81SR_PRIV int korad_kaxxxxp_set_value(struct sr_serial_dev_inst *serial,
3f9b48ae 82 int target, struct dev_context *devc)
d7083042 83{
8f39d569 84 char *msg;
2c240774 85 const char *cmd;
d7083042
HV
86 float value;
87 int ret;
88
3f9b48ae 89 g_mutex_lock(&devc->rw_mutex);
d7083042
HV
90 give_device_time_to_process(devc);
91
3f9b48ae 92 switch (target) {
16fc7ee2
UH
93 case KAXXXXP_CURRENT:
94 case KAXXXXP_VOLTAGE:
95 case KAXXXXP_STATUS:
3f9b48ae
FS
96 sr_err("Can't set measurable parameter %d.", target);
97 g_mutex_unlock(&devc->rw_mutex);
d7083042 98 return SR_ERR;
8da30037 99 case KAXXXXP_CURRENT_LIMIT:
d7083042 100 cmd = "ISET1:%05.3f";
8da30037 101 value = devc->set_current_limit;
d7083042 102 break;
8da30037 103 case KAXXXXP_VOLTAGE_TARGET:
d7083042 104 cmd = "VSET1:%05.2f";
8da30037 105 value = devc->set_voltage_target;
d7083042 106 break;
16fc7ee2 107 case KAXXXXP_OUTPUT:
d7083042 108 cmd = "OUT%01.0f";
8da30037
FS
109 value = (devc->set_output_enabled) ? 1 : 0;
110 /* Set value back to recognize changes */
111 devc->output_enabled = devc->set_output_enabled;
d7083042 112 break;
16fc7ee2 113 case KAXXXXP_BEEP:
d7083042 114 cmd = "BEEP%01.0f";
8da30037 115 value = (devc->set_beep_enabled) ? 1 : 0;
d7083042 116 break;
16fc7ee2 117 case KAXXXXP_OCP:
c40ed60f 118 cmd = "OCP%01.0f";
8da30037
FS
119 value = (devc->set_ocp_enabled) ? 1 : 0;
120 /* Set value back to recognize changes */
121 devc->ocp_enabled = devc->set_ocp_enabled;
c40ed60f 122 break;
16fc7ee2 123 case KAXXXXP_OVP:
c40ed60f 124 cmd = "OVP%01.0f";
8da30037
FS
125 value = (devc->set_ovp_enabled) ? 1 : 0;
126 /* Set value back to recognize changes */
127 devc->ovp_enabled = devc->set_ovp_enabled;
c40ed60f 128 break;
16fc7ee2 129 case KAXXXXP_SAVE:
d7083042
HV
130 cmd = "SAV%01.0f";
131 if (devc->program < 1 || devc->program > 5) {
132 sr_err("Only programs 1-5 supported and %d isn't "
133 "between them.", devc->program);
3f9b48ae 134 g_mutex_unlock(&devc->rw_mutex);
d7083042
HV
135 return SR_ERR;
136 }
137 value = devc->program;
138 break;
16fc7ee2 139 case KAXXXXP_RECALL:
d7083042
HV
140 cmd = "RCL%01.0f";
141 if (devc->program < 1 || devc->program > 5) {
142 sr_err("Only programs 1-5 supported and %d isn't "
143 "between them.", devc->program);
3f9b48ae 144 g_mutex_unlock(&devc->rw_mutex);
d7083042
HV
145 return SR_ERR;
146 }
147 value = devc->program;
148 break;
149 default:
3f9b48ae
FS
150 sr_err("Don't know how to set %d.", target);
151 g_mutex_unlock(&devc->rw_mutex);
d7083042
HV
152 return SR_ERR;
153 }
154
8f39d569 155 msg = g_malloc0(20 + 1);
d7083042 156 if (cmd)
8f39d569 157 sr_snprintf_ascii(msg, 20, cmd, value);
d7083042 158
16fc7ee2 159 ret = korad_kaxxxxp_send_cmd(serial, msg);
d7083042 160 devc->req_sent_at = g_get_monotonic_time();
8f39d569 161 g_free(msg);
3f9b48ae
FS
162
163 g_mutex_unlock(&devc->rw_mutex);
d7083042
HV
164
165 return ret;
166}
167
3f9b48ae
FS
168SR_PRIV int korad_kaxxxxp_get_value(struct sr_serial_dev_inst *serial,
169 int target, struct dev_context *devc)
d7083042 170{
3f9b48ae
FS
171 int ret, count;
172 char reply[6];
173 float *value;
174 char status_byte;
2e129b8b 175 gboolean prev_status;
d7083042 176
3f9b48ae 177 g_mutex_lock(&devc->rw_mutex);
d7083042
HV
178 give_device_time_to_process(devc);
179
3f9b48ae
FS
180 value = NULL;
181 count = 5;
182
183 switch (target) {
16fc7ee2 184 case KAXXXXP_CURRENT:
d7083042 185 /* Read current from device. */
16fc7ee2 186 ret = korad_kaxxxxp_send_cmd(serial, "IOUT1?");
3f9b48ae 187 value = &(devc->current);
d7083042 188 break;
8da30037 189 case KAXXXXP_CURRENT_LIMIT:
d7083042 190 /* Read set current from device. */
16fc7ee2 191 ret = korad_kaxxxxp_send_cmd(serial, "ISET1?");
8da30037 192 value = &(devc->current_limit);
d7083042 193 break;
16fc7ee2 194 case KAXXXXP_VOLTAGE:
d7083042 195 /* Read voltage from device. */
16fc7ee2 196 ret = korad_kaxxxxp_send_cmd(serial, "VOUT1?");
3f9b48ae 197 value = &(devc->voltage);
d7083042 198 break;
8da30037 199 case KAXXXXP_VOLTAGE_TARGET:
d7083042 200 /* Read set voltage from device. */
16fc7ee2 201 ret = korad_kaxxxxp_send_cmd(serial, "VSET1?");
8da30037 202 value = &(devc->voltage_target);
d7083042 203 break;
16fc7ee2
UH
204 case KAXXXXP_STATUS:
205 case KAXXXXP_OUTPUT:
3f9b48ae
FS
206 case KAXXXXP_OCP:
207 case KAXXXXP_OVP:
d7083042 208 /* Read status from device. */
16fc7ee2 209 ret = korad_kaxxxxp_send_cmd(serial, "STATUS?");
3f9b48ae 210 count = 1;
d7083042
HV
211 break;
212 default:
3f9b48ae
FS
213 sr_err("Don't know how to query %d.", target);
214 g_mutex_unlock(&devc->rw_mutex);
d7083042
HV
215 return SR_ERR;
216 }
217
218 devc->req_sent_at = g_get_monotonic_time();
d7083042 219
3f9b48ae
FS
220 if ((ret = korad_kaxxxxp_read_chars(serial, count, reply)) < 0) {
221 g_mutex_unlock(&devc->rw_mutex);
d7083042 222 return ret;
3f9b48ae 223 }
d7083042 224
3f9b48ae 225 reply[count] = 0;
d7083042 226
3f9b48ae
FS
227 if (value) {
228 sr_atof_ascii((const char *)&reply, value);
229 sr_dbg("value: %f", *value);
d7083042
HV
230 } else {
231 /* We have status reply. */
3f9b48ae 232 status_byte = reply[0];
2e129b8b
FS
233
234 /* Constant current channel one. */
235 prev_status = devc->cc_mode[0];
236 devc->cc_mode[0] = !(status_byte & (1 << 0));
237 devc->cc_mode_1_changed = devc->cc_mode[0] != prev_status;
238 /* Constant current channel two. */
239 prev_status = devc->cc_mode[1];
240 devc->cc_mode[1] = !(status_byte & (1 << 1));
241 devc->cc_mode_2_changed = devc->cc_mode[1] != prev_status;
242
d7083042 243 /*
2e129b8b 244 * Tracking:
d7083042
HV
245 * status_byte & ((1 << 2) | (1 << 3))
246 * 00 independent 01 series 11 parallel
247 */
2e129b8b
FS
248 devc->beep_enabled = status_byte & (1 << 4);
249
250 /* OCP enabled. */
251 prev_status = devc->ocp_enabled;
252 devc->ocp_enabled = status_byte & (1 << 5);
253 devc->ocp_enabled_changed = devc->ocp_enabled != prev_status;
254
255 /* Output status. */
256 prev_status = devc->output_enabled;
257 devc->output_enabled = status_byte & (1 << 6);
258 devc->output_enabled_changed = devc->output_enabled != prev_status;
259
260 /* OVP enabled, special handling for Velleman LABPS3005 quirk. */
261 if ((devc->model->model_id == VELLEMAN_LABPS3005D && devc->output_enabled) ||
262 devc->model->model_id != VELLEMAN_LABPS3005D) {
263
264 prev_status = devc->ovp_enabled;
265 devc->ovp_enabled = status_byte & (1 << 7);
266 devc->ovp_enabled_changed = devc->ovp_enabled != prev_status;
267 }
268
d7083042 269 sr_dbg("Status: 0x%02x", status_byte);
c40ed60f
HV
270 sr_spew("Status: CH1: constant %s CH2: constant %s. "
271 "Tracking would be %s. Device is "
272 "%s and %s. Buttons are %s. Output is %s "
8da30037 273 "and extra bit is %s.",
d7083042
HV
274 (status_byte & (1 << 0)) ? "voltage" : "current",
275 (status_byte & (1 << 1)) ? "voltage" : "current",
c40ed60f 276 (status_byte & (1 << 2)) ? "parallel" : "series",
d7083042
HV
277 (status_byte & (1 << 3)) ? "tracking" : "independent",
278 (status_byte & (1 << 4)) ? "beeping" : "silent",
279 (status_byte & (1 << 5)) ? "locked" : "unlocked",
c40ed60f
HV
280 (status_byte & (1 << 6)) ? "enabled" : "disabled",
281 (status_byte & (1 << 7)) ? "true" : "false");
d7083042 282 }
3f9b48ae 283
8abdf006 284 /* Read the sixth byte from ISET? BUG workaround. */
8da30037 285 if (target == KAXXXXP_CURRENT_LIMIT)
8abdf006 286 serial_read_blocking(serial, &status_byte, 1, 10);
3f9b48ae
FS
287
288 g_mutex_unlock(&devc->rw_mutex);
289
290 return ret;
291}
292
293SR_PRIV int korad_kaxxxxp_get_all_values(struct sr_serial_dev_inst *serial,
294 struct dev_context *devc)
295{
296 int ret, target;
297
298 for (target = KAXXXXP_CURRENT;
299 target <= KAXXXXP_STATUS; target++) {
300 if ((ret = korad_kaxxxxp_get_value(serial, target, devc)) < 0)
301 return ret;
302 }
d7083042
HV
303
304 return ret;
305}
306
307static void next_measurement(struct dev_context *devc)
308{
3f9b48ae 309 switch (devc->acquisition_target) {
16fc7ee2 310 case KAXXXXP_CURRENT:
3f9b48ae 311 devc->acquisition_target = KAXXXXP_VOLTAGE;
d7083042 312 break;
16fc7ee2 313 case KAXXXXP_VOLTAGE:
3f9b48ae 314 devc->acquisition_target = KAXXXXP_STATUS;
d7083042 315 break;
16fc7ee2 316 case KAXXXXP_STATUS:
3f9b48ae 317 devc->acquisition_target = KAXXXXP_CURRENT;
d7083042
HV
318 break;
319 default:
3f9b48ae
FS
320 devc->acquisition_target = KAXXXXP_CURRENT;
321 sr_err("Invalid target for next acquisition.");
d7083042
HV
322 }
323}
324
16fc7ee2 325SR_PRIV int korad_kaxxxxp_receive_data(int fd, int revents, void *cb_data)
e75ee7de 326{
d7083042 327 struct sr_dev_inst *sdi;
e75ee7de 328 struct dev_context *devc;
d7083042
HV
329 struct sr_serial_dev_inst *serial;
330 struct sr_datafeed_packet packet;
2e715341
UH
331 struct sr_datafeed_analog analog;
332 struct sr_analog_encoding encoding;
333 struct sr_analog_meaning meaning;
334 struct sr_analog_spec spec;
23165d7b 335 GSList *l;
e75ee7de
HV
336
337 (void)fd;
a7e48f3c 338 (void)revents;
e75ee7de
HV
339
340 if (!(sdi = cb_data))
341 return TRUE;
342
343 if (!(devc = sdi->priv))
344 return TRUE;
345
d7083042
HV
346 serial = sdi->conn;
347
a7e48f3c
FS
348 /* Get the value. */
349 korad_kaxxxxp_get_value(serial, devc->acquisition_target, devc);
350
351 /* Note: digits/spec_digits will be overridden later. */
352 sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
353
354 /* Send the value forward. */
355 packet.type = SR_DF_ANALOG;
356 packet.payload = &analog;
357 analog.num_samples = 1;
358 l = g_slist_copy(sdi->channels);
359 if (devc->acquisition_target == KAXXXXP_CURRENT) {
360 l = g_slist_remove_link(l, g_slist_nth(l, 0));
361 analog.meaning->channels = l;
362 analog.meaning->mq = SR_MQ_CURRENT;
363 analog.meaning->unit = SR_UNIT_AMPERE;
d1a3f3be 364 analog.meaning->mqflags = SR_MQFLAG_DC;
a7e48f3c
FS
365 analog.encoding->digits = 3;
366 analog.spec->spec_digits = 3;
367 analog.data = &devc->current;
368 sr_session_send(sdi, &packet);
369 } else if (devc->acquisition_target == KAXXXXP_VOLTAGE) {
370 l = g_slist_remove_link(l, g_slist_nth(l, 1));
371 analog.meaning->channels = l;
372 analog.meaning->mq = SR_MQ_VOLTAGE;
373 analog.meaning->unit = SR_UNIT_VOLT;
374 analog.meaning->mqflags = SR_MQFLAG_DC;
375 analog.encoding->digits = 2;
376 analog.spec->spec_digits = 2;
377 analog.data = &devc->voltage;
378 sr_session_send(sdi, &packet);
379 sr_sw_limits_update_samples_read(&devc->limits, 1);
2e129b8b
FS
380 } else if (devc->acquisition_target == KAXXXXP_STATUS) {
381 if (devc->cc_mode_1_changed) {
382 sr_session_send_meta(sdi, SR_CONF_REGULATION,
383 g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV"));
384 devc->cc_mode_1_changed = FALSE;
385 }
386 if (devc->cc_mode_2_changed) {
387 sr_session_send_meta(sdi, SR_CONF_REGULATION,
388 g_variant_new_string((devc->cc_mode[1]) ? "CC" : "CV"));
389 devc->cc_mode_2_changed = FALSE;
390 }
391 if (devc->output_enabled_changed) {
392 sr_session_send_meta(sdi, SR_CONF_ENABLED,
393 g_variant_new_boolean(devc->output_enabled));
394 devc->output_enabled_changed = FALSE;
395 }
396 if (devc->ocp_enabled_changed) {
397 sr_session_send_meta(sdi, SR_CONF_OVER_CURRENT_PROTECTION_ENABLED,
398 g_variant_new_boolean(devc->ocp_enabled));
399 devc->ocp_enabled_changed = FALSE;
400 }
401 if (devc->ovp_enabled_changed) {
402 sr_session_send_meta(sdi, SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED,
403 g_variant_new_boolean(devc->ovp_enabled));
404 devc->ovp_enabled_changed = FALSE;
405 }
d7083042 406 }
a7e48f3c 407 next_measurement(devc);
d7083042 408
3f9b48ae 409 if (sr_sw_limits_check(&devc->limits))
d2f7c417 410 sr_dev_acquisition_stop(sdi);
e75ee7de
HV
411
412 return TRUE;
413}