]>
Commit | Line | Data |
---|---|---|
a1bb33af | 1 | /* |
50985c20 | 2 | * This file is part of the libsigrok project. |
a1bb33af | 3 | * |
c73d2ea4 | 4 | * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com> |
b19f4622 | 5 | * Copyright (C) 2010-2012 Uwe Hermann <uwe@hermann-uwe.de> |
766456be | 6 | * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com> |
bce75f94 | 7 | * Copyright (C) 2014 Uffe Jakobsen <uffe@uffe.org> |
a1bb33af UH |
8 | * |
9 | * This program is free software: you can redistribute it and/or modify | |
10 | * it under the terms of the GNU General Public License as published by | |
11 | * the Free Software Foundation, either version 3 of the License, or | |
12 | * (at your option) any later version. | |
13 | * | |
14 | * This program is distributed in the hope that it will be useful, | |
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | * GNU General Public License for more details. | |
18 | * | |
19 | * You should have received a copy of the GNU General Public License | |
20 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
21 | */ | |
22 | ||
6ec6c43b | 23 | #include <config.h> |
54b38f64 | 24 | #include <string.h> |
d02a535e | 25 | #include <stdlib.h> |
a1bb33af | 26 | #include <glib.h> |
b541f837 | 27 | #include <glib/gstdio.h> |
0d4405ce | 28 | #include <libserialport.h> |
c1aae900 | 29 | #include <libsigrok/libsigrok.h> |
45c59c8b | 30 | #include "libsigrok-internal.h" |
041b579d DE |
31 | #ifdef G_OS_WIN32 |
32 | #include <windows.h> /* for HANDLE */ | |
33 | #endif | |
a1bb33af | 34 | |
e00b3f58 | 35 | /** @cond PRIVATE */ |
3544f848 | 36 | #define LOG_PREFIX "serial" |
e00b3f58 UH |
37 | /** @endcond */ |
38 | ||
39 | /** | |
40 | * @file | |
41 | * | |
42 | * Serial port handling. | |
43 | */ | |
44 | ||
45 | /** | |
46 | * @defgroup grp_serial Serial port handling | |
47 | * | |
48 | * Serial port handling functions. | |
49 | * | |
50 | * @{ | |
51 | */ | |
b19f4622 | 52 | |
b19f4622 UH |
53 | /** |
54 | * Open the specified serial port. | |
55 | * | |
299bdb24 | 56 | * @param serial Previously initialized serial port structure. |
a9cf2035 | 57 | * @param[in] flags Flags to use when opening the serial port. Possible flags |
d9251a2c | 58 | * include SERIAL_RDWR, SERIAL_RDONLY. |
b19f4622 | 59 | * |
299bdb24 BV |
60 | * If the serial structure contains a serialcomm string, it will be |
61 | * passed to serial_set_paramstr() after the port is opened. | |
62 | * | |
d0a92abd MH |
63 | * @retval SR_OK Success. |
64 | * @retval SR_ERR Failure. | |
e00b3f58 UH |
65 | * |
66 | * @private | |
b19f4622 | 67 | */ |
299bdb24 | 68 | SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags) |
d02a535e | 69 | { |
a9bce5a5 ML |
70 | int ret; |
71 | char *error; | |
13cd8197 | 72 | int sp_flags = 0; |
b19f4622 | 73 | |
299bdb24 BV |
74 | if (!serial) { |
75 | sr_dbg("Invalid serial port."); | |
76 | return SR_ERR; | |
77 | } | |
78 | ||
79 | sr_spew("Opening serial port '%s' (flags %d).", serial->port, flags); | |
b19f4622 | 80 | |
c9bc57b6 ML |
81 | sp_get_port_by_name(serial->port, &serial->data); |
82 | ||
13cd8197 ML |
83 | if (flags & SERIAL_RDWR) |
84 | sp_flags = (SP_MODE_READ | SP_MODE_WRITE); | |
85 | else if (flags & SERIAL_RDONLY) | |
86 | sp_flags = SP_MODE_READ; | |
9647ce69 | 87 | |
13cd8197 | 88 | ret = sp_open(serial->data, sp_flags); |
a9bce5a5 | 89 | |
a0dfaa6c UH |
90 | switch (ret) { |
91 | case SP_ERR_ARG: | |
92 | sr_err("Attempt to open serial port with invalid parameters."); | |
93 | return SR_ERR_ARG; | |
94 | case SP_ERR_FAIL: | |
95 | error = sp_last_error_message(); | |
cb7b165b UH |
96 | sr_err("Error opening port (%d): %s.", |
97 | sp_last_error_code(), error); | |
a0dfaa6c UH |
98 | sp_free_error_message(error); |
99 | return SR_ERR; | |
a54dd31e UH |
100 | } |
101 | ||
299bdb24 BV |
102 | if (serial->serialcomm) |
103 | return serial_set_paramstr(serial, serial->serialcomm); | |
104 | else | |
105 | return SR_OK; | |
d02a535e BV |
106 | } |
107 | ||
b19f4622 UH |
108 | /** |
109 | * Close the specified serial port. | |
110 | * | |
299bdb24 | 111 | * @param serial Previously initialized serial port structure. |
b19f4622 | 112 | * |
d0a92abd MH |
113 | * @retval SR_OK Success. |
114 | * @retval SR_ERR Failure. | |
e00b3f58 UH |
115 | * |
116 | * @private | |
2119ab03 | 117 | */ |
299bdb24 | 118 | SR_PRIV int serial_close(struct sr_serial_dev_inst *serial) |
d02a535e | 119 | { |
299bdb24 | 120 | int ret; |
a9bce5a5 | 121 | char *error; |
299bdb24 BV |
122 | |
123 | if (!serial) { | |
124 | sr_dbg("Invalid serial port."); | |
125 | return SR_ERR; | |
126 | } | |
127 | ||
64ecf7ee ML |
128 | if (!serial->data) { |
129 | sr_dbg("Cannot close unopened serial port %s.", serial->port); | |
299bdb24 BV |
130 | return SR_ERR; |
131 | } | |
132 | ||
64ecf7ee | 133 | sr_spew("Closing serial port %s.", serial->port); |
b19f4622 | 134 | |
c9bc57b6 | 135 | ret = sp_close(serial->data); |
a9bce5a5 | 136 | |
a0dfaa6c UH |
137 | switch (ret) { |
138 | case SP_ERR_ARG: | |
139 | sr_err("Attempt to close an invalid serial port."); | |
140 | return SR_ERR_ARG; | |
141 | case SP_ERR_FAIL: | |
142 | error = sp_last_error_message(); | |
cb7b165b UH |
143 | sr_err("Error closing port (%d): %s.", |
144 | sp_last_error_code(), error); | |
a0dfaa6c UH |
145 | sp_free_error_message(error); |
146 | return SR_ERR; | |
b19f4622 | 147 | } |
299bdb24 | 148 | |
64ecf7ee ML |
149 | sp_free_port(serial->data); |
150 | serial->data = NULL; | |
151 | ||
6a76efeb | 152 | return SR_OK; |
d02a535e BV |
153 | } |
154 | ||
b19f4622 | 155 | /** |
299bdb24 | 156 | * Flush serial port buffers. |
b19f4622 | 157 | * |
299bdb24 | 158 | * @param serial Previously initialized serial port structure. |
b19f4622 | 159 | * |
d0a92abd MH |
160 | * @retval SR_OK Success. |
161 | * @retval SR_ERR Failure. | |
e00b3f58 UH |
162 | * |
163 | * @private | |
1fdb75e1 | 164 | */ |
299bdb24 | 165 | SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial) |
06d64eb8 | 166 | { |
299bdb24 | 167 | int ret; |
a9bce5a5 | 168 | char *error; |
299bdb24 BV |
169 | |
170 | if (!serial) { | |
171 | sr_dbg("Invalid serial port."); | |
172 | return SR_ERR; | |
173 | } | |
174 | ||
64ecf7ee ML |
175 | if (!serial->data) { |
176 | sr_dbg("Cannot flush unopened serial port %s.", serial->port); | |
299bdb24 BV |
177 | return SR_ERR; |
178 | } | |
179 | ||
64ecf7ee | 180 | sr_spew("Flushing serial port %s.", serial->port); |
b19f4622 | 181 | |
13cd8197 | 182 | ret = sp_flush(serial->data, SP_BUF_BOTH); |
a9bce5a5 | 183 | |
a0dfaa6c UH |
184 | switch (ret) { |
185 | case SP_ERR_ARG: | |
186 | sr_err("Attempt to flush an invalid serial port."); | |
187 | return SR_ERR_ARG; | |
188 | case SP_ERR_FAIL: | |
189 | error = sp_last_error_message(); | |
cb7b165b UH |
190 | sr_err("Error flushing port (%d): %s.", |
191 | sp_last_error_code(), error); | |
a0dfaa6c UH |
192 | sp_free_error_message(error); |
193 | return SR_ERR; | |
299bdb24 | 194 | } |
b19f4622 | 195 | |
6a76efeb | 196 | return SR_OK; |
06d64eb8 BV |
197 | } |
198 | ||
bce75f94 UJ |
199 | /** |
200 | * Drain serial port buffers. | |
201 | * | |
202 | * @param serial Previously initialized serial port structure. | |
203 | * | |
204 | * @retval SR_OK Success. | |
205 | * @retval SR_ERR Failure. | |
e00b3f58 UH |
206 | * |
207 | * @private | |
bce75f94 UJ |
208 | */ |
209 | SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial) | |
210 | { | |
211 | int ret; | |
212 | char *error; | |
213 | ||
214 | if (!serial) { | |
215 | sr_dbg("Invalid serial port."); | |
216 | return SR_ERR; | |
217 | } | |
218 | ||
219 | if (!serial->data) { | |
220 | sr_dbg("Cannot drain unopened serial port %s.", serial->port); | |
221 | return SR_ERR; | |
222 | } | |
223 | ||
224 | sr_spew("Draining serial port %s.", serial->port); | |
225 | ||
226 | ret = sp_drain(serial->data); | |
227 | ||
228 | if (ret == SP_ERR_FAIL) { | |
229 | error = sp_last_error_message(); | |
230 | sr_err("Error draining port (%d): %s.", | |
231 | sp_last_error_code(), error); | |
232 | sp_free_error_message(error); | |
233 | return SR_ERR; | |
234 | } | |
235 | ||
236 | return SR_OK; | |
237 | } | |
238 | ||
9a474211 | 239 | static int _serial_write(struct sr_serial_dev_inst *serial, |
eead2782 | 240 | const void *buf, size_t count, int nonblocking, unsigned int timeout_ms) |
2119ab03 | 241 | { |
299bdb24 | 242 | ssize_t ret; |
a9bce5a5 | 243 | char *error; |
299bdb24 BV |
244 | |
245 | if (!serial) { | |
246 | sr_dbg("Invalid serial port."); | |
6a76efeb | 247 | return SR_ERR; |
299bdb24 BV |
248 | } |
249 | ||
64ecf7ee ML |
250 | if (!serial->data) { |
251 | sr_dbg("Cannot use unopened serial port %s.", serial->port); | |
6a76efeb | 252 | return SR_ERR; |
299bdb24 BV |
253 | } |
254 | ||
9a474211 | 255 | if (nonblocking) |
9647ce69 ML |
256 | ret = sp_nonblocking_write(serial->data, buf, count); |
257 | else | |
eead2782 | 258 | ret = sp_blocking_write(serial->data, buf, count, timeout_ms); |
a9bce5a5 | 259 | |
a0dfaa6c UH |
260 | switch (ret) { |
261 | case SP_ERR_ARG: | |
262 | sr_err("Attempted serial port write with invalid arguments."); | |
263 | return SR_ERR_ARG; | |
264 | case SP_ERR_FAIL: | |
265 | error = sp_last_error_message(); | |
cb7b165b | 266 | sr_err("Write error (%d): %s.", sp_last_error_code(), error); |
a0dfaa6c UH |
267 | sp_free_error_message(error); |
268 | return SR_ERR; | |
a9bce5a5 ML |
269 | } |
270 | ||
6433156c | 271 | sr_spew("Wrote %zd/%zu bytes.", ret, count); |
b19f4622 UH |
272 | |
273 | return ret; | |
2119ab03 UH |
274 | } |
275 | ||
b19f4622 | 276 | /** |
98edee79 | 277 | * Write a number of bytes to the specified serial port, blocking until finished. |
b19f4622 | 278 | * |
299bdb24 | 279 | * @param serial Previously initialized serial port structure. |
a9cf2035 MH |
280 | * @param[in] buf Buffer containing the bytes to write. |
281 | * @param[in] count Number of bytes to write. | |
eead2782 | 282 | * @param[in] timeout_ms Timeout in ms, or 0 for no timeout. |
b19f4622 | 283 | * |
a9cf2035 MH |
284 | * @retval SR_ERR_ARG Invalid argument. |
285 | * @retval SR_ERR Other error. | |
eead2782 ML |
286 | * @retval other The number of bytes written. If this is less than the number |
287 | * specified in the call, the timeout was reached. | |
e00b3f58 UH |
288 | * |
289 | * @private | |
2119ab03 | 290 | */ |
9a474211 | 291 | SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial, |
eead2782 | 292 | const void *buf, size_t count, unsigned int timeout_ms) |
9a474211 | 293 | { |
eead2782 | 294 | return _serial_write(serial, buf, count, 0, timeout_ms); |
9a474211 ML |
295 | } |
296 | ||
a9cf2035 MH |
297 | /** |
298 | * Write a number of bytes to the specified serial port, return immediately. | |
98edee79 ML |
299 | * |
300 | * @param serial Previously initialized serial port structure. | |
301 | * @param[in] buf Buffer containing the bytes to write. | |
302 | * @param[in] count Number of bytes to write. | |
303 | * | |
304 | * @retval SR_ERR_ARG Invalid argument. | |
305 | * @retval SR_ERR Other error. | |
306 | * @retval other The number of bytes written. | |
e00b3f58 UH |
307 | * |
308 | * @private | |
309 | */ | |
9a474211 ML |
310 | SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial, |
311 | const void *buf, size_t count) | |
312 | { | |
eead2782 | 313 | return _serial_write(serial, buf, count, 1, 0); |
9a474211 ML |
314 | } |
315 | ||
316 | static int _serial_read(struct sr_serial_dev_inst *serial, void *buf, | |
eead2782 | 317 | size_t count, int nonblocking, unsigned int timeout_ms) |
2119ab03 | 318 | { |
299bdb24 | 319 | ssize_t ret; |
c4d85a40 | 320 | char *error; |
299bdb24 BV |
321 | |
322 | if (!serial) { | |
323 | sr_dbg("Invalid serial port."); | |
6a76efeb | 324 | return SR_ERR; |
299bdb24 BV |
325 | } |
326 | ||
64ecf7ee ML |
327 | if (!serial->data) { |
328 | sr_dbg("Cannot use unopened serial port %s.", serial->port); | |
6a76efeb | 329 | return SR_ERR; |
299bdb24 BV |
330 | } |
331 | ||
9a474211 | 332 | if (nonblocking) |
9647ce69 ML |
333 | ret = sp_nonblocking_read(serial->data, buf, count); |
334 | else | |
eead2782 | 335 | ret = sp_blocking_read(serial->data, buf, count, timeout_ms); |
2119ab03 | 336 | |
a0dfaa6c UH |
337 | switch (ret) { |
338 | case SP_ERR_ARG: | |
339 | sr_err("Attempted serial port read with invalid arguments."); | |
340 | return SR_ERR_ARG; | |
c4d85a40 UH |
341 | case SP_ERR_FAIL: |
342 | error = sp_last_error_message(); | |
cb7b165b | 343 | sr_err("Read error (%d): %s.", sp_last_error_code(), error); |
c4d85a40 UH |
344 | sp_free_error_message(error); |
345 | return SR_ERR; | |
a9bce5a5 ML |
346 | } |
347 | ||
c4d85a40 | 348 | if (ret > 0) |
6433156c | 349 | sr_spew("Read %zd/%zu bytes.", ret, count); |
b19f4622 UH |
350 | |
351 | return ret; | |
2119ab03 UH |
352 | } |
353 | ||
9a474211 | 354 | /** |
98edee79 | 355 | * Read a number of bytes from the specified serial port, block until finished. |
9a474211 ML |
356 | * |
357 | * @param serial Previously initialized serial port structure. | |
358 | * @param buf Buffer where to store the bytes that are read. | |
a9cf2035 | 359 | * @param[in] count The number of bytes to read. |
eead2782 | 360 | * @param[in] timeout_ms Timeout in ms, or 0 for no timeout. |
9a474211 | 361 | * |
a9cf2035 | 362 | * @retval SR_ERR_ARG Invalid argument. |
d9251a2c UH |
363 | * @retval SR_ERR Other error. |
364 | * @retval other The number of bytes read. If this is less than the number | |
eead2782 | 365 | * requested, the timeout was reached. |
e00b3f58 UH |
366 | * |
367 | * @private | |
9a474211 | 368 | */ |
9a474211 | 369 | SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf, |
eead2782 | 370 | size_t count, unsigned int timeout_ms) |
9a474211 | 371 | { |
eead2782 | 372 | return _serial_read(serial, buf, count, 0, timeout_ms); |
9a474211 ML |
373 | } |
374 | ||
a9cf2035 MH |
375 | /** |
376 | * Try to read up to @a count bytes from the specified serial port, return | |
377 | * immediately with what's available. | |
98edee79 ML |
378 | * |
379 | * @param serial Previously initialized serial port structure. | |
380 | * @param buf Buffer where to store the bytes that are read. | |
381 | * @param[in] count The number of bytes to read. | |
382 | * | |
383 | * @retval SR_ERR_ARG Invalid argument. | |
d9251a2c UH |
384 | * @retval SR_ERR Other error. |
385 | * @retval other The number of bytes read. | |
e00b3f58 UH |
386 | * |
387 | * @private | |
a9cf2035 | 388 | */ |
9a474211 ML |
389 | SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf, |
390 | size_t count) | |
391 | { | |
eead2782 | 392 | return _serial_read(serial, buf, count, 1, 0); |
9a474211 ML |
393 | } |
394 | ||
b19f4622 UH |
395 | /** |
396 | * Set serial parameters for the specified serial port. | |
397 | * | |
299bdb24 | 398 | * @param serial Previously initialized serial port structure. |
04cb9157 MH |
399 | * @param[in] baudrate The baudrate to set. |
400 | * @param[in] bits The number of data bits to use (5, 6, 7 or 8). | |
401 | * @param[in] parity The parity setting to use (0 = none, 1 = even, 2 = odd). | |
402 | * @param[in] stopbits The number of stop bits to use (1 or 2). | |
403 | * @param[in] flowcontrol The flow control settings to use (0 = none, | |
d9251a2c | 404 | * 1 = RTS/CTS, 2 = XON/XOFF). |
04cb9157 MH |
405 | * @param[in] rts Status of RTS line (0 or 1; required by some interfaces). |
406 | * @param[in] dtr Status of DTR line (0 or 1; required by some interfaces). | |
2119ab03 | 407 | * |
d0a92abd | 408 | * @retval SR_OK Success. |
04cb9157 | 409 | * @retval SR_ERR Failure. |
e00b3f58 UH |
410 | * |
411 | * @private | |
1ff7712c | 412 | */ |
299bdb24 | 413 | SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate, |
39e5d798 UH |
414 | int bits, int parity, int stopbits, |
415 | int flowcontrol, int rts, int dtr) | |
d02a535e | 416 | { |
a9bce5a5 ML |
417 | int ret; |
418 | char *error; | |
25b66c3c | 419 | struct sp_port_config *config; |
a9bce5a5 | 420 | |
299bdb24 BV |
421 | if (!serial) { |
422 | sr_dbg("Invalid serial port."); | |
423 | return SR_ERR; | |
424 | } | |
425 | ||
64ecf7ee ML |
426 | if (!serial->data) { |
427 | sr_dbg("Cannot configure unopened serial port %s.", serial->port); | |
299bdb24 BV |
428 | return SR_ERR; |
429 | } | |
430 | ||
64ecf7ee | 431 | sr_spew("Setting serial parameters on port %s.", serial->port); |
b19f4622 | 432 | |
25b66c3c ML |
433 | sp_new_config(&config); |
434 | sp_set_config_baudrate(config, baudrate); | |
435 | sp_set_config_bits(config, bits); | |
13cd8197 ML |
436 | switch (parity) { |
437 | case 0: | |
25b66c3c | 438 | sp_set_config_parity(config, SP_PARITY_NONE); |
13cd8197 ML |
439 | break; |
440 | case 1: | |
25b66c3c | 441 | sp_set_config_parity(config, SP_PARITY_EVEN); |
13cd8197 ML |
442 | break; |
443 | case 2: | |
25b66c3c | 444 | sp_set_config_parity(config, SP_PARITY_ODD); |
13cd8197 ML |
445 | break; |
446 | default: | |
447 | return SR_ERR_ARG; | |
448 | } | |
25b66c3c ML |
449 | sp_set_config_stopbits(config, stopbits); |
450 | sp_set_config_rts(config, flowcontrol == 1 ? SP_RTS_FLOW_CONTROL : rts); | |
451 | sp_set_config_cts(config, flowcontrol == 1 ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE); | |
452 | sp_set_config_dtr(config, dtr); | |
453 | sp_set_config_dsr(config, SP_DSR_IGNORE); | |
454 | sp_set_config_xon_xoff(config, flowcontrol == 2 ? SP_XONXOFF_INOUT : SP_XONXOFF_DISABLED); | |
455 | ||
456 | ret = sp_set_config(serial->data, config); | |
457 | sp_free_config(config); | |
a9bce5a5 | 458 | |
a0dfaa6c UH |
459 | switch (ret) { |
460 | case SP_ERR_ARG: | |
461 | sr_err("Invalid arguments for setting serial port parameters."); | |
462 | return SR_ERR_ARG; | |
463 | case SP_ERR_FAIL: | |
464 | error = sp_last_error_message(); | |
cb7b165b UH |
465 | sr_err("Error setting serial port parameters (%d): %s.", |
466 | sp_last_error_code(), error); | |
a0dfaa6c UH |
467 | sp_free_error_message(error); |
468 | return SR_ERR; | |
700dcd5c UH |
469 | } |
470 | ||
e46b8fb1 | 471 | return SR_OK; |
d02a535e | 472 | } |
792fc686 | 473 | |
299bdb24 | 474 | /** |
48d3238e | 475 | * Set serial parameters for the specified serial port from parameter string. |
299bdb24 BV |
476 | * |
477 | * @param serial Previously initialized serial port structure. | |
48d3238e MH |
478 | * @param[in] paramstr A serial communication parameters string of the form |
479 | * "<baudrate>/<bits><parity><stopbits>{/<option>}".\n | |
d9251a2c | 480 | * Examples: "9600/8n1", "600/7o2/dtr=1/rts=0" or "460800/8n1/flow=2".\n |
48d3238e MH |
481 | * \<baudrate\>=integer Baud rate.\n |
482 | * \<bits\>=5|6|7|8 Number of data bits.\n | |
483 | * \<parity\>=n|e|o None, even, odd.\n | |
484 | * \<stopbits\>=1|2 One or two stop bits.\n | |
485 | * Options:\n | |
486 | * dtr=0|1 Set DTR off resp. on.\n | |
487 | * flow=0|1|2 Flow control. 0 for none, 1 for RTS/CTS, 2 for XON/XOFF.\n | |
488 | * rts=0|1 Set RTS off resp. on.\n | |
489 | * Please note that values and combinations of these parameters must be | |
490 | * supported by the concrete serial interface hardware and the drivers for it. | |
e00b3f58 | 491 | * |
04cb9157 MH |
492 | * @retval SR_OK Success. |
493 | * @retval SR_ERR Failure. | |
e00b3f58 UH |
494 | * |
495 | * @private | |
299bdb24 | 496 | */ |
299bdb24 BV |
497 | SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial, |
498 | const char *paramstr) | |
792fc686 | 499 | { |
e00b3f58 | 500 | /** @cond PRIVATE */ |
48d3238e | 501 | #define SERIAL_COMM_SPEC "^(\\d+)/([5678])([neo])([12])(.*)$" |
e00b3f58 | 502 | /** @endcond */ |
48d3238e | 503 | |
792fc686 BV |
504 | GRegex *reg; |
505 | GMatchInfo *match; | |
26ddb5ba | 506 | int speed, databits, parity, stopbits, flow, rts, dtr, i; |
71caaad4 | 507 | char *mstr, **opts, **kv; |
792fc686 | 508 | |
26ddb5ba | 509 | speed = databits = parity = stopbits = flow = 0; |
71caaad4 | 510 | rts = dtr = -1; |
ea088bb6 | 511 | sr_spew("Parsing parameters from \"%s\".", paramstr); |
792fc686 BV |
512 | reg = g_regex_new(SERIAL_COMM_SPEC, 0, 0, NULL); |
513 | if (g_regex_match(reg, paramstr, 0, &match)) { | |
514 | if ((mstr = g_match_info_fetch(match, 1))) | |
515 | speed = strtoul(mstr, NULL, 10); | |
516 | g_free(mstr); | |
517 | if ((mstr = g_match_info_fetch(match, 2))) | |
518 | databits = strtoul(mstr, NULL, 10); | |
519 | g_free(mstr); | |
520 | if ((mstr = g_match_info_fetch(match, 3))) { | |
521 | switch (mstr[0]) { | |
522 | case 'n': | |
4d6a5008 | 523 | parity = SP_PARITY_NONE; |
792fc686 BV |
524 | break; |
525 | case 'e': | |
4d6a5008 | 526 | parity = SP_PARITY_EVEN; |
792fc686 BV |
527 | break; |
528 | case 'o': | |
4d6a5008 | 529 | parity = SP_PARITY_ODD; |
792fc686 BV |
530 | break; |
531 | } | |
532 | } | |
533 | g_free(mstr); | |
534 | if ((mstr = g_match_info_fetch(match, 4))) | |
535 | stopbits = strtoul(mstr, NULL, 10); | |
536 | g_free(mstr); | |
71caaad4 BV |
537 | if ((mstr = g_match_info_fetch(match, 5)) && mstr[0] != '\0') { |
538 | if (mstr[0] != '/') { | |
539 | sr_dbg("missing separator before extra options"); | |
540 | speed = 0; | |
541 | } else { | |
542 | /* A set of "key=value" options separated by / */ | |
543 | opts = g_strsplit(mstr + 1, "/", 0); | |
544 | for (i = 0; opts[i]; i++) { | |
545 | kv = g_strsplit(opts[i], "=", 2); | |
546 | if (!strncmp(kv[0], "rts", 3)) { | |
547 | if (kv[1][0] == '1') | |
548 | rts = 1; | |
549 | else if (kv[1][0] == '0') | |
550 | rts = 0; | |
551 | else { | |
552 | sr_dbg("invalid value for rts: %c", kv[1][0]); | |
553 | speed = 0; | |
554 | } | |
555 | } else if (!strncmp(kv[0], "dtr", 3)) { | |
556 | if (kv[1][0] == '1') | |
557 | dtr = 1; | |
558 | else if (kv[1][0] == '0') | |
559 | dtr = 0; | |
560 | else { | |
561 | sr_dbg("invalid value for dtr: %c", kv[1][0]); | |
562 | speed = 0; | |
563 | } | |
26ddb5ba | 564 | } else if (!strncmp(kv[0], "flow", 4)) { |
565 | if (kv[1][0] == '0') | |
566 | flow = 0; | |
567 | else if (kv[1][0] == '1') | |
568 | flow = 1; | |
569 | else if (kv[1][0] == '2') | |
570 | flow = 2; | |
571 | else { | |
572 | sr_dbg("invalid value for flow: %c", kv[1][0]); | |
573 | speed = 0; | |
574 | } | |
71caaad4 BV |
575 | } |
576 | g_strfreev(kv); | |
577 | } | |
578 | g_strfreev(opts); | |
579 | } | |
580 | } | |
581 | g_free(mstr); | |
792fc686 BV |
582 | } |
583 | g_match_info_unref(match); | |
584 | g_regex_unref(reg); | |
585 | ||
ea088bb6 AG |
586 | if (speed) { |
587 | return serial_set_params(serial, speed, databits, parity, | |
26ddb5ba | 588 | stopbits, flow, rts, dtr); |
ea088bb6 AG |
589 | } else { |
590 | sr_dbg("Could not infer speed from parameter string."); | |
792fc686 | 591 | return SR_ERR_ARG; |
ea088bb6 | 592 | } |
792fc686 BV |
593 | } |
594 | ||
299bdb24 BV |
595 | /** |
596 | * Read a line from the specified serial port. | |
597 | * | |
598 | * @param serial Previously initialized serial port structure. | |
599 | * @param buf Buffer where to store the bytes that are read. | |
600 | * @param buflen Size of the buffer. | |
04cb9157 | 601 | * @param[in] timeout_ms How long to wait for a line to come in. |
299bdb24 BV |
602 | * |
603 | * Reading stops when CR of LR is found, which is stripped from the buffer. | |
604 | * | |
04cb9157 MH |
605 | * @retval SR_OK Success. |
606 | * @retval SR_ERR Failure. | |
e00b3f58 UH |
607 | * |
608 | * @private | |
299bdb24 BV |
609 | */ |
610 | SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf, | |
611 | int *buflen, gint64 timeout_ms) | |
6f22a8ef | 612 | { |
bf505eed | 613 | gint64 start, remaining; |
6f22a8ef UH |
614 | int maxlen, len; |
615 | ||
64ecf7ee | 616 | if (!serial) { |
299bdb24 BV |
617 | sr_dbg("Invalid serial port."); |
618 | return SR_ERR; | |
619 | } | |
620 | ||
64ecf7ee ML |
621 | if (!serial->data) { |
622 | sr_dbg("Cannot use unopened serial port %s.", serial->port); | |
299bdb24 BV |
623 | return -1; |
624 | } | |
625 | ||
6f22a8ef | 626 | start = g_get_monotonic_time(); |
bf505eed | 627 | remaining = timeout_ms; |
6f22a8ef UH |
628 | |
629 | maxlen = *buflen; | |
630 | *buflen = len = 0; | |
0c5f2abc | 631 | while (1) { |
6f22a8ef UH |
632 | len = maxlen - *buflen - 1; |
633 | if (len < 1) | |
634 | break; | |
bf505eed | 635 | len = sp_blocking_read(serial->data, *buf + *buflen, 1, remaining); |
6f22a8ef UH |
636 | if (len > 0) { |
637 | *buflen += len; | |
638 | *(*buf + *buflen) = '\0'; | |
318dd53c BV |
639 | if (*buflen > 0 && (*(*buf + *buflen - 1) == '\r' |
640 | || *(*buf + *buflen - 1) == '\n')) { | |
641 | /* Strip CR/LF and terminate. */ | |
6f22a8ef UH |
642 | *(*buf + --*buflen) = '\0'; |
643 | break; | |
644 | } | |
645 | } | |
bf505eed ML |
646 | /* Reduce timeout by time elapsed. */ |
647 | remaining = timeout_ms - ((g_get_monotonic_time() - start) / 1000); | |
648 | if (remaining <= 0) | |
6f22a8ef UH |
649 | /* Timeout */ |
650 | break; | |
5715e84f DT |
651 | if (len < 1) |
652 | g_usleep(2000); | |
6f22a8ef | 653 | } |
318dd53c BV |
654 | if (*buflen) |
655 | sr_dbg("Received %d: '%s'.", *buflen, *buf); | |
6f22a8ef UH |
656 | |
657 | return SR_OK; | |
658 | } | |
766456be UH |
659 | |
660 | /** | |
661 | * Try to find a valid packet in a serial data stream. | |
662 | * | |
663 | * @param serial Previously initialized serial port structure. | |
664 | * @param buf Buffer containing the bytes to write. | |
04cb9157 MH |
665 | * @param buflen Size of the buffer. |
666 | * @param[in] packet_size Size, in bytes, of a valid packet. | |
766456be | 667 | * @param is_valid Callback that assesses whether the packet is valid or not. |
04cb9157 | 668 | * @param[in] timeout_ms The timeout after which, if no packet is detected, to |
d9251a2c | 669 | * abort scanning. |
04cb9157 | 670 | * @param[in] baudrate The baudrate of the serial port. This parameter is not |
d9251a2c UH |
671 | * critical, but it helps fine tune the serial port polling |
672 | * delay. | |
766456be | 673 | * |
d0a92abd | 674 | * @retval SR_OK Valid packet was found within the given timeout. |
04cb9157 | 675 | * @retval SR_ERR Failure. |
e00b3f58 UH |
676 | * |
677 | * @private | |
766456be UH |
678 | */ |
679 | SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial, | |
680 | uint8_t *buf, size_t *buflen, | |
144f6660 UH |
681 | size_t packet_size, |
682 | packet_valid_callback is_valid, | |
766456be UH |
683 | uint64_t timeout_ms, int baudrate) |
684 | { | |
685 | uint64_t start, time, byte_delay_us; | |
686 | size_t ibuf, i, maxlen; | |
6433156c | 687 | ssize_t len; |
766456be UH |
688 | |
689 | maxlen = *buflen; | |
690 | ||
64ecf7ee ML |
691 | sr_dbg("Detecting packets on %s (timeout = %" PRIu64 |
692 | "ms, baudrate = %d).", serial->port, timeout_ms, baudrate); | |
766456be UH |
693 | |
694 | if (maxlen < (packet_size / 2) ) { | |
695 | sr_err("Buffer size must be at least twice the packet size."); | |
696 | return SR_ERR; | |
697 | } | |
698 | ||
766456be | 699 | /* Assume 8n1 transmission. That is 10 bits for every byte. */ |
1a46cc62 | 700 | byte_delay_us = 10 * ((1000 * 1000) / baudrate); |
766456be UH |
701 | start = g_get_monotonic_time(); |
702 | ||
703 | i = ibuf = len = 0; | |
704 | while (ibuf < maxlen) { | |
18e4d5bc | 705 | len = serial_read_nonblocking(serial, &buf[ibuf], 1); |
766456be UH |
706 | if (len > 0) { |
707 | ibuf += len; | |
708 | } else if (len == 0) { | |
006dbe55 | 709 | /* No logging, already done in serial_read(). */ |
766456be UH |
710 | } else { |
711 | /* Error reading byte, but continuing anyway. */ | |
712 | } | |
551c3d8c AG |
713 | |
714 | time = g_get_monotonic_time() - start; | |
715 | time /= 1000; | |
716 | ||
766456be UH |
717 | if ((ibuf - i) >= packet_size) { |
718 | /* We have at least a packet's worth of data. */ | |
719 | if (is_valid(&buf[i])) { | |
6433156c | 720 | sr_spew("Found valid %zu-byte packet after " |
766456be UH |
721 | "%" PRIu64 "ms.", (ibuf - i), time); |
722 | *buflen = ibuf; | |
723 | return SR_OK; | |
724 | } else { | |
6433156c | 725 | sr_spew("Got %zu bytes, but not a valid " |
766456be UH |
726 | "packet.", (ibuf - i)); |
727 | } | |
728 | /* Not a valid packet. Continue searching. */ | |
729 | i++; | |
730 | } | |
551c3d8c | 731 | if (time >= timeout_ms) { |
766456be | 732 | /* Timeout */ |
6433156c | 733 | sr_dbg("Detection timed out after %" PRIu64 "ms.", time); |
766456be UH |
734 | break; |
735 | } | |
5715e84f DT |
736 | if (len < 1) |
737 | g_usleep(byte_delay_us); | |
766456be UH |
738 | } |
739 | ||
740 | *buflen = ibuf; | |
741 | ||
6433156c | 742 | sr_err("Didn't find a valid packet (read %zu bytes).", *buflen); |
766456be UH |
743 | |
744 | return SR_ERR; | |
745 | } | |
1bd9e678 DJ |
746 | |
747 | /** | |
748 | * Extract the serial device and options from the options linked list. | |
749 | * | |
750 | * @param options List of options passed from the command line. | |
f3f19d11 | 751 | * @param serial_device Pointer where to store the extracted serial device. |
1bd9e678 DJ |
752 | * @param serial_options Pointer where to store the optional extracted serial |
753 | * options. | |
754 | * | |
755 | * @return SR_OK if a serial_device is found, SR_ERR if no device is found. The | |
756 | * returned string should not be freed by the caller. | |
e00b3f58 UH |
757 | * |
758 | * @private | |
1bd9e678 DJ |
759 | */ |
760 | SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device, | |
761 | const char **serial_options) | |
762 | { | |
763 | GSList *l; | |
764 | struct sr_config *src; | |
765 | ||
766 | *serial_device = NULL; | |
767 | ||
768 | for (l = options; l; l = l->next) { | |
769 | src = l->data; | |
770 | switch (src->key) { | |
771 | case SR_CONF_CONN: | |
772 | *serial_device = g_variant_get_string(src->data, NULL); | |
b1a7ca3b | 773 | sr_dbg("Parsed serial device: %s.", *serial_device); |
1bd9e678 | 774 | break; |
1bd9e678 DJ |
775 | case SR_CONF_SERIALCOMM: |
776 | *serial_options = g_variant_get_string(src->data, NULL); | |
b1a7ca3b | 777 | sr_dbg("Parsed serial options: %s.", *serial_options); |
1bd9e678 DJ |
778 | break; |
779 | } | |
780 | } | |
781 | ||
782 | if (!*serial_device) { | |
b1a7ca3b | 783 | sr_dbg("No serial device specified."); |
1bd9e678 DJ |
784 | return SR_ERR; |
785 | } | |
786 | ||
787 | return SR_OK; | |
788 | } | |
abc4b335 | 789 | |
e00b3f58 | 790 | /** @cond PRIVATE */ |
041b579d | 791 | #ifdef G_OS_WIN32 |
ba1949f5 | 792 | typedef HANDLE event_handle; |
a0a4c0fb | 793 | #else |
ba1949f5 | 794 | typedef int event_handle; |
a0a4c0fb | 795 | #endif |
e00b3f58 | 796 | /** @endcond */ |
ba1949f5 | 797 | |
e00b3f58 | 798 | /** @private */ |
102f1239 BV |
799 | SR_PRIV int serial_source_add(struct sr_session *session, |
800 | struct sr_serial_dev_inst *serial, int events, int timeout, | |
801 | sr_receive_data_callback cb, void *cb_data) | |
ba1949f5 | 802 | { |
cbc1413f DE |
803 | struct sp_event_set *event_set; |
804 | gintptr poll_fd; | |
805 | unsigned int poll_events; | |
ba1949f5 | 806 | enum sp_event mask = 0; |
ba1949f5 | 807 | |
cbc1413f DE |
808 | if ((events & (G_IO_IN|G_IO_ERR)) && (events & G_IO_OUT)) { |
809 | sr_err("Cannot poll input/error and output simultaneously."); | |
810 | return SR_ERR_ARG; | |
811 | } | |
812 | ||
813 | if (sp_new_event_set(&event_set) != SP_OK) | |
ba1949f5 ML |
814 | return SR_ERR; |
815 | ||
816 | if (events & G_IO_IN) | |
817 | mask |= SP_EVENT_RX_READY; | |
818 | if (events & G_IO_OUT) | |
819 | mask |= SP_EVENT_TX_READY; | |
820 | if (events & G_IO_ERR) | |
821 | mask |= SP_EVENT_ERROR; | |
822 | ||
cbc1413f DE |
823 | if (sp_add_port_events(event_set, serial->data, mask) != SP_OK) { |
824 | sp_free_event_set(event_set); | |
ba1949f5 ML |
825 | return SR_ERR; |
826 | } | |
cbc1413f DE |
827 | if (event_set->count != 1) { |
828 | sr_err("Unexpected number (%u) of event handles to poll.", | |
829 | event_set->count); | |
830 | sp_free_event_set(event_set); | |
831 | return SR_ERR; | |
ba1949f5 ML |
832 | } |
833 | ||
cbc1413f DE |
834 | poll_fd = (gintptr) ((event_handle *)event_set->handles)[0]; |
835 | mask = event_set->masks[0]; | |
836 | ||
837 | sp_free_event_set(event_set); | |
838 | ||
839 | poll_events = 0; | |
840 | if (mask & SP_EVENT_RX_READY) | |
841 | poll_events |= G_IO_IN; | |
842 | if (mask & SP_EVENT_TX_READY) | |
843 | poll_events |= G_IO_OUT; | |
844 | if (mask & SP_EVENT_ERROR) | |
845 | poll_events |= G_IO_ERR; | |
846 | /* | |
847 | * Using serial->data as the key for the event source is not quite | |
848 | * proper, as it makes it impossible to create another event source | |
849 | * for the same serial port. However, these fixed keys will soon be | |
850 | * removed from the API anyway, so this is OK for now. | |
851 | */ | |
852 | return sr_session_fd_source_add(session, serial->data, | |
853 | poll_fd, poll_events, timeout, cb, cb_data); | |
abc4b335 | 854 | } |
7faa3e88 | 855 | |
e00b3f58 | 856 | /** @private */ |
102f1239 BV |
857 | SR_PRIV int serial_source_remove(struct sr_session *session, |
858 | struct sr_serial_dev_inst *serial) | |
7faa3e88 | 859 | { |
cbc1413f | 860 | return sr_session_source_remove_internal(session, serial->data); |
7faa3e88 | 861 | } |
b541f837 | 862 | |
b1a7ca3b UH |
863 | /** |
864 | * Create/allocate a new sr_serial_port structure. | |
865 | * | |
866 | * @param name The OS dependent name of the serial port. Must not be NULL. | |
867 | * @param description An end user friendly description for the serial port. | |
868 | * Can be NULL (in that case the empty string is used | |
869 | * as description). | |
870 | * | |
871 | * @return The newly allocated sr_serial_port struct. | |
872 | */ | |
24287ea9 AJ |
873 | static struct sr_serial_port *sr_serial_new(const char *name, |
874 | const char *description) | |
875 | { | |
876 | struct sr_serial_port *serial; | |
877 | ||
878 | if (!name) | |
879 | return NULL; | |
880 | ||
b1a7ca3b | 881 | serial = g_malloc(sizeof(struct sr_serial_port)); |
24287ea9 AJ |
882 | serial->name = g_strdup(name); |
883 | serial->description = g_strdup(description ? description : ""); | |
b1a7ca3b | 884 | |
24287ea9 AJ |
885 | return serial; |
886 | } | |
887 | ||
b1a7ca3b UH |
888 | /** |
889 | * Free a previously allocated sr_serial_port structure. | |
890 | * | |
891 | * @param serial The sr_serial_port struct to free. Must not be NULL. | |
892 | */ | |
24287ea9 AJ |
893 | SR_API void sr_serial_free(struct sr_serial_port *serial) |
894 | { | |
b1a7ca3b | 895 | if (!serial) |
24287ea9 AJ |
896 | return; |
897 | g_free(serial->name); | |
898 | g_free(serial->description); | |
899 | g_free(serial); | |
900 | } | |
901 | ||
902 | /** | |
903 | * List available serial devices. | |
904 | * | |
905 | * @return A GSList of strings containing the path of the serial devices or | |
906 | * NULL if no serial device is found. The returned list must be freed | |
907 | * by the caller. | |
908 | */ | |
909 | SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver) | |
910 | { | |
911 | GSList *tty_devs = NULL; | |
912 | struct sp_port **ports; | |
b1a7ca3b | 913 | struct sr_serial_port *port; |
24287ea9 AJ |
914 | int i; |
915 | ||
b1a7ca3b | 916 | /* Currently unused, but will be used by some drivers later on. */ |
24287ea9 AJ |
917 | (void)driver; |
918 | ||
919 | if (sp_list_ports(&ports) != SP_OK) | |
920 | return NULL; | |
921 | ||
b1a7ca3b UH |
922 | for (i = 0; ports[i]; i++) { |
923 | port = sr_serial_new(sp_get_port_name(ports[i]), | |
924 | sp_get_port_description(ports[i])); | |
24287ea9 AJ |
925 | tty_devs = g_slist_append(tty_devs, port); |
926 | } | |
927 | ||
928 | sp_free_port_list(ports); | |
b1a7ca3b | 929 | |
24287ea9 AJ |
930 | return tty_devs; |
931 | } | |
932 | ||
b541f837 AJ |
933 | /** |
934 | * Find USB serial devices via the USB vendor ID and product ID. | |
935 | * | |
d0a92abd MH |
936 | * @param[in] vendor_id Vendor ID of the USB device. |
937 | * @param[in] product_id Product ID of the USB device. | |
b541f837 AJ |
938 | * |
939 | * @return A GSList of strings containing the path of the serial device or | |
940 | * NULL if no serial device is found. The returned list must be freed | |
941 | * by the caller. | |
e00b3f58 UH |
942 | * |
943 | * @private | |
b541f837 AJ |
944 | */ |
945 | SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id) | |
946 | { | |
01f6e330 AJ |
947 | GSList *tty_devs = NULL; |
948 | struct sp_port **ports; | |
949 | int i, vid, pid; | |
b541f837 | 950 | |
01f6e330 AJ |
951 | if (sp_list_ports(&ports) != SP_OK) |
952 | return NULL; | |
b541f837 | 953 | |
b1a7ca3b | 954 | for (i = 0; ports[i]; i++) |
01f6e330 AJ |
955 | if (sp_get_port_transport(ports[i]) == SP_TRANSPORT_USB && |
956 | sp_get_port_usb_vid_pid(ports[i], &vid, &pid) == SP_OK && | |
b1a7ca3b | 957 | vid == vendor_id && pid == product_id) { |
01f6e330 | 958 | tty_devs = g_slist_prepend(tty_devs, |
b1a7ca3b UH |
959 | g_strdup(sp_get_port_name(ports[i]))); |
960 | } | |
b541f837 | 961 | |
01f6e330 | 962 | sp_free_port_list(ports); |
b1a7ca3b | 963 | |
b541f837 | 964 | return tty_devs; |
b541f837 | 965 | } |
c5cfc735 | 966 | |
e00b3f58 | 967 | /** @private */ |
c5cfc735 BV |
968 | SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes) |
969 | { | |
970 | struct sp_port_config *config; | |
971 | int timeout_ms, bits, baud, tmp; | |
972 | ||
973 | /* Default to 1s. */ | |
974 | timeout_ms = 1000; | |
975 | ||
976 | if (sp_new_config(&config) < 0) | |
977 | return timeout_ms; | |
978 | ||
979 | bits = baud = 0; | |
980 | do { | |
981 | if (sp_get_config(port->data, config) < 0) | |
982 | break; | |
983 | ||
984 | /* Start bit. */ | |
985 | bits = 1; | |
986 | if (sp_get_config_bits(config, &tmp) < 0) | |
987 | break; | |
988 | bits += tmp; | |
989 | if (sp_get_config_stopbits(config, &tmp) < 0) | |
990 | break; | |
991 | bits += tmp; | |
992 | if (sp_get_config_baudrate(config, &tmp) < 0) | |
993 | break; | |
994 | baud = tmp; | |
995 | } while (FALSE); | |
996 | ||
997 | if (bits && baud) { | |
998 | /* Throw in 10ms for misc OS overhead. */ | |
999 | timeout_ms = 10; | |
1000 | timeout_ms += ((1000.0 / baud) * bits) * num_bytes; | |
1001 | } | |
1002 | ||
1003 | sp_free_config(config); | |
1004 | ||
1005 | return timeout_ms; | |
1006 | } | |
e00b3f58 UH |
1007 | |
1008 | /** @} */ |