2 * This file is part of the libsigrok project.
4 * Copyright (C) 2018 Sven Bursch-Osewold <sb_git@bursch.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 /* Log a byte-array as hex values. */
24 static void log_buf(const char *message, uint8_t buf[], size_t count)
26 char buffer[count * 2 + 1];
28 for (size_t j = 0; j < count; j++)
29 sprintf(&buffer[2 * j], "%02X", buf[j]);
31 buffer[count * 2] = 0;
33 sr_dbg("%s: %s [%zu bytes]", message, buffer, count);
36 /* Send a command to the device. */
37 static int send_cmd(struct sr_serial_dev_inst *serial, uint8_t buf[], size_t count)
41 log_buf("Sending", buf, count);
42 ret = serial_write_blocking(serial, buf, count, 0);
44 sr_err("Error sending command: %d.", ret);
48 return (ret == (int)count) ? SR_OK : SR_ERR;
51 /* Decode high byte and low byte into a float. */
52 static float decode_value(uint8_t hi, uint8_t lo, float divisor)
54 return ((float)hi * 240.0 + (float)lo) / divisor;
57 /* Encode a float into high byte and low byte. */
58 static void encode_value(float current, uint8_t *hi, uint8_t *lo, float divisor)
62 value = (int)(current * divisor);
63 sr_dbg("Value %d %d %d", value, value / 240, value % 240);
68 /* Send updated configuration values to the load. */
69 static int send_cfg(struct sr_serial_dev_inst *serial, struct dev_context *devc)
71 uint8_t send[] = { 0xfa, 0x07, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf8 };
73 encode_value(devc->current_limit, &send[2], &send[3], 1000.0);
75 send[8] = send[1] ^ send[2] ^ send[3] ^ send[4] ^ send[5] ^ \
78 return send_cmd(serial, send, 10);
81 /* Send the init/connect sequence; drive starts sending voltage and current. */
82 SR_PRIV int ebd_init(struct sr_serial_dev_inst *serial, struct dev_context *devc)
84 uint8_t init[] = { 0xfa, 0x05, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x05, 0xf8 };
88 int ret = send_cmd(serial, init, 10);
95 /* Start the load functionality. */
96 SR_PRIV int ebd_loadstart(struct sr_serial_dev_inst *serial, struct dev_context *devc)
98 uint8_t start[] = { 0xfa, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0xf8 };
101 ret = send_cmd(serial, start, 10);
102 sr_dbg("Current limit: %f.", devc->current_limit);
103 if (ebd_current_is0(devc))
106 ret = send_cfg(serial, devc);
108 sr_dbg("Load activated.");
109 devc->load_activated = TRUE;
115 /* Stop the load functionality. */
116 SR_PRIV int ebd_loadstop(struct sr_serial_dev_inst *serial, struct dev_context *devc)
119 uint8_t stop[] = { 0xfa, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xF8 };
121 ret = send_cmd(serial, stop, 10);
123 devc->load_activated = FALSE;
128 /* Stop the drive. */
129 SR_PRIV int ebd_stop(struct sr_serial_dev_inst *serial, struct dev_context *devc)
131 uint8_t stop[] = { 0xfa, 0x06, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x06, 0xF8 };
136 ret = send_cmd(serial, stop, 10);
138 devc->load_activated = FALSE;
139 devc->running= FALSE;
145 /** Read count bytes from the serial connection. */
146 SR_PRIV int ebd_read_chars(struct sr_serial_dev_inst *serial, int count, uint8_t *buf)
148 int ret, received, turns;
154 ret = serial_read_blocking(serial, buf + received,
155 count - received, serial_timeout(serial, count));
157 sr_err("Error %d reading %d bytes.", ret, count);
162 } while ((received < count) && (turns < 100));
164 log_buf("Received", buf, received);
169 SR_PRIV int ebd_receive_data(int fd, int revents, void *cb_data)
171 struct sr_dev_inst *sdi;
172 struct dev_context *devc;
173 struct sr_serial_dev_inst *serial;
174 struct sr_datafeed_packet packet;
175 struct sr_datafeed_analog analog;
176 struct sr_analog_encoding encoding;
177 struct sr_analog_meaning meaning;
178 struct sr_analog_spec spec;
179 float voltage, current, current_limit;
185 if (!(sdi = cb_data))
188 if (!(devc = sdi->priv))
193 uint8_t reply[MSG_LEN];
194 int ret = ebd_read_chars(serial, MSG_LEN, reply);
196 /* Tests for correct message. */
197 if (ret != MSG_LEN) {
198 sr_err("Message invalid [Len].");
199 return (ret < 0) ? ret : SR_ERR;
202 uint8_t xor = reply[1] ^ reply[2] ^ reply[3] ^ reply[4] ^ \
203 reply[5] ^ reply[6] ^ reply[7] ^ reply[8] ^ \
204 reply[9] ^ reply[10] ^ reply[11] ^ reply[12] ^ \
205 reply[13] ^ reply[14] ^ reply[15] ^ reply[16];
207 if (reply[MSG_FRAME_BEGIN_POS] != MSG_FRAME_BEGIN || \
208 reply[MSG_FRAME_END_POS] != MSG_FRAME_END || \
209 xor != reply[MSG_CHECKSUM_POS]) {
210 sr_err("Message invalid [XOR, BEGIN/END].");
214 /* Calculate values. */
215 sr_dbg("V: %02X %02X A: %02X %02X -- Limit %02X %02X", reply[4],
216 reply[5], reply[2], reply[3], reply[10], reply[11]);
218 voltage = decode_value(reply[4], reply[5], 1000.0);
219 current = decode_value(reply[2], reply[3], 10000.0);
220 current_limit = decode_value(reply[10], reply[11], 1000.0);
222 sr_dbg("Voltage %f", voltage);
223 sr_dbg("Current %f", current);
224 sr_dbg("Current limit %f", current_limit);
227 std_session_send_df_frame_begin(sdi);
229 sr_analog_init(&analog, &encoding, &meaning, &spec, 4);
231 packet.type = SR_DF_ANALOG;
232 packet.payload = &analog;
233 analog.num_samples = 1;
236 l = g_slist_copy(sdi->channels);
237 l = g_slist_remove_link(l, g_slist_nth(l, 1));
238 meaning.channels = l;
239 meaning.mq = SR_MQ_VOLTAGE;
240 meaning.mqflags = SR_MQFLAG_DC;
241 meaning.unit = SR_UNIT_VOLT;
242 analog.data = &voltage;
243 sr_session_send(sdi, &packet);
247 l = g_slist_copy(sdi->channels);
248 l = g_slist_remove_link(l, g_slist_nth(l, 0));
249 meaning.channels = l;
250 meaning.mq = SR_MQ_CURRENT;
251 meaning.mqflags = SR_MQFLAG_DC;
252 meaning.unit = SR_UNIT_AMPERE;
253 analog.data = ¤t;
254 sr_session_send(sdi, &packet);
258 std_session_send_df_frame_end(sdi);
260 sr_sw_limits_update_samples_read(&devc->limits, 1);
261 if (sr_sw_limits_check(&devc->limits))
262 sr_dev_acquisition_stop(sdi);
267 SR_PRIV int ebd_get_current_limit(const struct sr_dev_inst *sdi, float *current)
269 struct dev_context *devc;
271 if (!(devc = sdi->priv))
274 g_mutex_lock(&devc->rw_mutex);
275 *current = devc->current_limit;
276 g_mutex_unlock(&devc->rw_mutex);
281 SR_PRIV int ebd_set_current_limit(const struct sr_dev_inst *sdi, float current)
283 struct dev_context *devc;
286 if (!(devc = sdi->priv))
289 g_mutex_lock(&devc->rw_mutex);
290 devc->current_limit = current;
292 if (!devc->running) {
293 sr_dbg("Setting current limit later.");
294 g_mutex_unlock(&devc->rw_mutex);
298 sr_dbg("Setting current limit to %fV.", current);
300 if (devc->load_activated) {
301 if (ebd_current_is0(devc)) {
303 ret = ebd_loadstop(sdi->conn, devc);
305 /* Send new current. */
306 ret = send_cfg(sdi->conn, devc);
309 if (ebd_current_is0(devc)) {
314 ret = ebd_loadstart(sdi->conn, devc);
318 g_mutex_unlock(&devc->rw_mutex);
323 SR_PRIV gboolean ebd_current_is0(struct dev_context *devc)
325 return devc->current_limit < 0.001;