]>
Commit | Line | Data |
---|---|---|
a1bb33af UH |
1 | /* |
2 | * This file is part of the sigrok project. | |
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> |
a1bb33af UH |
7 | * |
8 | * This program is free software: you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License as published by | |
10 | * the Free Software Foundation, either version 3 of the License, or | |
11 | * (at your option) any later version. | |
12 | * | |
13 | * This program is distributed in the hope that it will be useful, | |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | * GNU General Public License for more details. | |
17 | * | |
18 | * You should have received a copy of the GNU General Public License | |
19 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
20 | */ | |
21 | ||
54b38f64 | 22 | #include <string.h> |
d02a535e BV |
23 | #include <sys/types.h> |
24 | #include <sys/stat.h> | |
25 | #include <fcntl.h> | |
26 | #include <unistd.h> | |
926b866c | 27 | #ifdef _WIN32 |
a9f54bcd | 28 | #include <windows.h> |
926b866c UH |
29 | #else |
30 | #include <glob.h> | |
d02a535e | 31 | #include <termios.h> |
0f84cda0 | 32 | #include <sys/ioctl.h> |
926b866c | 33 | #endif |
d02a535e | 34 | #include <stdlib.h> |
b19f4622 | 35 | #include <errno.h> |
a1bb33af | 36 | #include <glib.h> |
45c59c8b BV |
37 | #include "libsigrok.h" |
38 | #include "libsigrok-internal.h" | |
a1bb33af | 39 | |
b19f4622 UH |
40 | /* Message logging helpers with driver-specific prefix string. */ |
41 | #define DRIVER_LOG_DOMAIN "serial: " | |
42 | #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args) | |
43 | #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args) | |
44 | #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args) | |
45 | #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args) | |
46 | #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args) | |
47 | #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args) | |
48 | ||
926b866c UH |
49 | // FIXME: Must be moved, or rather passed as function argument. |
50 | #ifdef _WIN32 | |
a0ecd83b | 51 | static HANDLE hdl; |
926b866c UH |
52 | #endif |
53 | ||
b19f4622 UH |
54 | /** |
55 | * Open the specified serial port. | |
56 | * | |
299bdb24 | 57 | * @param serial Previously initialized serial port structure. |
a54dd31e UH |
58 | * @param flags Flags to use when opening the serial port. Possible flags |
59 | * include SERIAL_RDWR, SERIAL_RDONLY, SERIAL_NONBLOCK. | |
b19f4622 | 60 | * |
299bdb24 BV |
61 | * If the serial structure contains a serialcomm string, it will be |
62 | * passed to serial_set_paramstr() after the port is opened. | |
63 | * | |
64 | * @return SR_OK on success, SR_ERR on failure. | |
b19f4622 | 65 | */ |
299bdb24 | 66 | SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags) |
d02a535e | 67 | { |
a54dd31e UH |
68 | int flags_local = 0; |
69 | #ifdef _WIN32 | |
70 | DWORD desired_access = 0, flags_and_attributes = 0; | |
71 | #endif | |
b19f4622 | 72 | |
299bdb24 BV |
73 | if (!serial) { |
74 | sr_dbg("Invalid serial port."); | |
75 | return SR_ERR; | |
76 | } | |
77 | ||
78 | sr_spew("Opening serial port '%s' (flags %d).", serial->port, flags); | |
b19f4622 | 79 | |
926b866c | 80 | #ifdef _WIN32 |
a54dd31e UH |
81 | /* Map 'flags' to the OS-specific settings. */ |
82 | desired_access |= GENERIC_READ; | |
83 | flags_and_attributes = FILE_ATTRIBUTE_NORMAL; | |
84 | if (flags & SERIAL_RDWR) | |
85 | desired_access |= GENERIC_WRITE; | |
86 | if (flags & SERIAL_NONBLOCK) | |
87 | flags_and_attributes |= FILE_FLAG_OVERLAPPED; | |
88 | ||
89 | hdl = CreateFile(serial->port, desired_access, 0, 0, | |
90 | OPEN_EXISTING, flags_and_attributes, 0); | |
926b866c | 91 | if (hdl == INVALID_HANDLE_VALUE) { |
299bdb24 BV |
92 | sr_err("Error opening serial port '%s'.", serial->port); |
93 | return SR_ERR; | |
926b866c | 94 | } |
926b866c | 95 | #else |
a54dd31e UH |
96 | /* Map 'flags' to the OS-specific settings. */ |
97 | if (flags & SERIAL_RDWR) | |
98 | flags_local |= O_RDWR; | |
99 | if (flags & SERIAL_RDONLY) | |
100 | flags_local |= O_RDONLY; | |
101 | if (flags & SERIAL_NONBLOCK) | |
102 | flags_local |= O_NONBLOCK; | |
103 | ||
104 | if ((serial->fd = open(serial->port, flags_local)) < 0) { | |
299bdb24 | 105 | sr_err("Error opening serial port '%s': %s.", serial->port, |
b19f4622 | 106 | strerror(errno)); |
299bdb24 | 107 | return SR_ERR; |
a54dd31e UH |
108 | } |
109 | ||
110 | sr_spew("Opened serial port '%s' (fd %d).", serial->port, serial->fd); | |
926b866c | 111 | #endif |
299bdb24 BV |
112 | |
113 | if (serial->serialcomm) | |
114 | return serial_set_paramstr(serial, serial->serialcomm); | |
115 | else | |
116 | return SR_OK; | |
d02a535e BV |
117 | } |
118 | ||
b19f4622 UH |
119 | /** |
120 | * Close the specified serial port. | |
121 | * | |
299bdb24 | 122 | * @param serial Previously initialized serial port structure. |
b19f4622 | 123 | * |
299bdb24 | 124 | * @return SR_OK on success, SR_ERR on failure. |
2119ab03 | 125 | */ |
299bdb24 | 126 | SR_PRIV int serial_close(struct sr_serial_dev_inst *serial) |
d02a535e | 127 | { |
299bdb24 BV |
128 | int ret; |
129 | ||
130 | if (!serial) { | |
131 | sr_dbg("Invalid serial port."); | |
132 | return SR_ERR; | |
133 | } | |
134 | ||
135 | if (serial->fd == -1) { | |
136 | sr_dbg("Cannot close unopened serial port %s (fd %d).", | |
137 | serial->port, serial->fd); | |
138 | return SR_ERR; | |
139 | } | |
140 | ||
141 | sr_spew("Closing serial port %s (fd %d).", serial->port, serial->fd); | |
142 | ret = SR_OK; | |
b19f4622 | 143 | |
926b866c | 144 | #ifdef _WIN32 |
2119ab03 | 145 | /* Returns non-zero upon success, 0 upon failure. */ |
299bdb24 BV |
146 | if (CloseHandle(hdl) == 0) |
147 | ret = SR_ERR; | |
926b866c | 148 | #else |
2119ab03 | 149 | /* Returns 0 upon success, -1 upon failure. */ |
299bdb24 BV |
150 | if (close(serial->fd) < 0) { |
151 | sr_err("Error closing serial port: %s (fd %d).", strerror(errno), | |
152 | serial->fd); | |
153 | ret = SR_ERR; | |
b19f4622 | 154 | } |
299bdb24 BV |
155 | #endif |
156 | ||
157 | serial->fd = -1; | |
b19f4622 UH |
158 | |
159 | return ret; | |
d02a535e BV |
160 | } |
161 | ||
b19f4622 | 162 | /** |
299bdb24 | 163 | * Flush serial port buffers. |
b19f4622 | 164 | * |
299bdb24 | 165 | * @param serial Previously initialized serial port structure. |
b19f4622 | 166 | * |
299bdb24 | 167 | * @return SR_OK on success, SR_ERR on failure. |
1fdb75e1 | 168 | */ |
299bdb24 | 169 | SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial) |
06d64eb8 | 170 | { |
299bdb24 BV |
171 | int ret; |
172 | ||
173 | if (!serial) { | |
174 | sr_dbg("Invalid serial port."); | |
175 | return SR_ERR; | |
176 | } | |
177 | ||
178 | if (serial->fd == -1) { | |
179 | sr_dbg("Cannot flush unopened serial port %s (fd %d).", | |
180 | serial->port, serial->fd); | |
181 | return SR_ERR; | |
182 | } | |
183 | ||
184 | sr_spew("Flushing serial port %s (fd %d).", serial->port, serial->fd); | |
185 | ret = SR_OK; | |
b19f4622 | 186 | |
1fdb75e1 UH |
187 | #ifdef _WIN32 |
188 | /* Returns non-zero upon success, 0 upon failure. */ | |
4da1a800 | 189 | if (PurgeComm(hdl, PURGE_RXCLEAR | PURGE_TXCLEAR) == 0) { |
299bdb24 BV |
190 | sr_err("Error flushing serial port: %s.", strerror(errno)); |
191 | ret = SR_ERR; | |
192 | } | |
1fdb75e1 UH |
193 | #else |
194 | /* Returns 0 upon success, -1 upon failure. */ | |
299bdb24 | 195 | if (tcflush(serial->fd, TCIOFLUSH) < 0) { |
b19f4622 | 196 | sr_err("Error flushing serial port: %s.", strerror(errno)); |
299bdb24 BV |
197 | ret = SR_ERR; |
198 | } | |
b19f4622 UH |
199 | |
200 | return ret; | |
1fdb75e1 | 201 | #endif |
06d64eb8 BV |
202 | } |
203 | ||
b19f4622 | 204 | /** |
2119ab03 | 205 | * Write a number of bytes to the specified serial port. |
b19f4622 | 206 | * |
299bdb24 | 207 | * @param serial Previously initialized serial port structure. |
b19f4622 UH |
208 | * @param buf Buffer containing the bytes to write. |
209 | * @param count Number of bytes to write. | |
210 | * | |
211 | * @return The number of bytes written, or -1 upon failure. | |
2119ab03 | 212 | */ |
299bdb24 BV |
213 | SR_PRIV int serial_write(struct sr_serial_dev_inst *serial, |
214 | const void *buf, size_t count) | |
2119ab03 | 215 | { |
299bdb24 BV |
216 | ssize_t ret; |
217 | ||
218 | if (!serial) { | |
219 | sr_dbg("Invalid serial port."); | |
220 | return -1; | |
221 | } | |
222 | ||
223 | if (serial->fd == -1) { | |
224 | sr_dbg("Cannot use unopened serial port %s (fd %d).", | |
225 | serial->port, serial->fd); | |
226 | return -1; | |
227 | } | |
228 | ||
2119ab03 UH |
229 | #ifdef _WIN32 |
230 | DWORD tmp = 0; | |
231 | ||
232 | /* FIXME */ | |
233 | /* Returns non-zero upon success, 0 upon failure. */ | |
234 | WriteFile(hdl, buf, count, &tmp, NULL); | |
235 | #else | |
236 | /* Returns the number of bytes written, or -1 upon failure. */ | |
299bdb24 | 237 | ret = write(serial->fd, buf, count); |
b19f4622 | 238 | if (ret < 0) |
299bdb24 | 239 | sr_err("Write error: %s.", strerror(errno)); |
302c4b5a | 240 | else |
299bdb24 BV |
241 | sr_spew("Wrote %d/%d bytes (fd %d).", ret, count, serial->fd); |
242 | #endif | |
b19f4622 UH |
243 | |
244 | return ret; | |
2119ab03 UH |
245 | } |
246 | ||
b19f4622 | 247 | /** |
2119ab03 | 248 | * Read a number of bytes from the specified serial port. |
b19f4622 | 249 | * |
299bdb24 | 250 | * @param serial Previously initialized serial port structure. |
b19f4622 UH |
251 | * @param buf Buffer where to store the bytes that are read. |
252 | * @param count The number of bytes to read. | |
253 | * | |
254 | * @return The number of bytes read, or -1 upon failure. | |
2119ab03 | 255 | */ |
299bdb24 BV |
256 | SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf, |
257 | size_t count) | |
2119ab03 | 258 | { |
299bdb24 BV |
259 | ssize_t ret; |
260 | ||
261 | if (!serial) { | |
262 | sr_dbg("Invalid serial port."); | |
263 | return -1; | |
264 | } | |
265 | ||
266 | if (serial->fd == -1) { | |
267 | sr_dbg("Cannot use unopened serial port %s (fd %d).", | |
268 | serial->port, serial->fd); | |
269 | return -1; | |
270 | } | |
271 | ||
2119ab03 UH |
272 | #ifdef _WIN32 |
273 | DWORD tmp = 0; | |
274 | ||
275 | /* FIXME */ | |
276 | /* Returns non-zero upon success, 0 upon failure. */ | |
277 | return ReadFile(hdl, buf, count, &tmp, NULL); | |
278 | #else | |
279 | /* Returns the number of bytes read, or -1 upon failure. */ | |
299bdb24 BV |
280 | ret = read(serial->fd, buf, count); |
281 | if (ret < 0) | |
b19f4622 UH |
282 | /* |
283 | * Should be sr_err(), but that would yield lots of | |
284 | * "Resource temporarily unavailable" messages. | |
285 | */ | |
299bdb24 BV |
286 | sr_spew("Read error: %s (fd %d).", strerror(errno), serial->fd); |
287 | else | |
288 | sr_spew("Read %d/%d bytes (fd %d).", ret, count, serial->fd); | |
289 | #endif | |
b19f4622 UH |
290 | |
291 | return ret; | |
2119ab03 UH |
292 | } |
293 | ||
b19f4622 UH |
294 | /** |
295 | * Set serial parameters for the specified serial port. | |
296 | * | |
299bdb24 | 297 | * @param serial Previously initialized serial port structure. |
b19f4622 UH |
298 | * @param baudrate The baudrate to set. |
299 | * @param bits The number of data bits to use. | |
300 | * @param parity The parity setting to use (0 = none, 1 = even, 2 = odd). | |
301 | * @param stopbits The number of stop bits to use (1 or 2). | |
302 | * @param flowcontrol The flow control settings to use (0 = none, 1 = RTS/CTS, | |
303 | * 2 = XON/XOFF). | |
2119ab03 | 304 | * |
b19f4622 | 305 | * @return SR_OK upon success, SR_ERR upon failure. |
1ff7712c | 306 | */ |
299bdb24 | 307 | SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate, |
39e5d798 UH |
308 | int bits, int parity, int stopbits, |
309 | int flowcontrol, int rts, int dtr) | |
d02a535e | 310 | { |
299bdb24 BV |
311 | if (!serial) { |
312 | sr_dbg("Invalid serial port."); | |
313 | return SR_ERR; | |
314 | } | |
315 | ||
316 | if (serial->fd == -1) { | |
317 | sr_dbg("Cannot configure unopened serial port %s (fd %d).", | |
39e5d798 | 318 | serial->port, serial->fd); |
299bdb24 BV |
319 | return SR_ERR; |
320 | } | |
321 | ||
322 | sr_spew("Setting serial parameters on port %s (fd %d).", serial->port, | |
39e5d798 | 323 | serial->fd); |
b19f4622 | 324 | |
926b866c UH |
325 | #ifdef _WIN32 |
326 | DCB dcb; | |
327 | ||
5ddb0cc7 UH |
328 | if (!GetCommState(hdl, &dcb)) { |
329 | sr_err("Failed to get comm state on port %s (fd %d): %d.", | |
330 | serial->port, serial->fd, GetLastError()); | |
e46b8fb1 | 331 | return SR_ERR; |
5ddb0cc7 | 332 | } |
926b866c | 333 | |
0abee507 | 334 | switch (baudrate) { |
5ae35c29 UH |
335 | /* |
336 | * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to | |
337 | * have documented CBR_* macros. | |
338 | */ | |
339 | case 110: | |
340 | dcb.BaudRate = CBR_110; | |
926b866c | 341 | break; |
5ae35c29 UH |
342 | case 300: |
343 | dcb.BaudRate = CBR_300; | |
926b866c | 344 | break; |
5ae35c29 UH |
345 | case 600: |
346 | dcb.BaudRate = CBR_600; | |
926b866c | 347 | break; |
5ae35c29 UH |
348 | case 1200: |
349 | dcb.BaudRate = CBR_1200; | |
926b866c | 350 | break; |
5ae35c29 UH |
351 | case 2400: |
352 | dcb.BaudRate = CBR_2400; | |
926b866c | 353 | break; |
e8e9dcdd AG |
354 | case 4800: |
355 | dcb.BaudRate = CBR_4800; | |
356 | break; | |
5ae35c29 UH |
357 | case 9600: |
358 | dcb.BaudRate = CBR_9600; | |
359 | break; | |
360 | case 14400: | |
361 | dcb.BaudRate = CBR_14400; /* Not available on Unix? */ | |
362 | break; | |
363 | case 19200: | |
364 | dcb.BaudRate = CBR_19200; | |
365 | break; | |
366 | case 38400: | |
367 | dcb.BaudRate = CBR_38400; | |
368 | break; | |
369 | case 57600: | |
370 | dcb.BaudRate = CBR_57600; | |
371 | break; | |
372 | case 115200: | |
373 | dcb.BaudRate = CBR_115200; | |
374 | break; | |
375 | case 128000: | |
376 | dcb.BaudRate = CBR_128000; /* Not available on Unix? */ | |
377 | break; | |
378 | case 256000: | |
379 | dcb.BaudRate = CBR_256000; /* Not available on Unix? */ | |
0f708301 | 380 | break; |
926b866c | 381 | default: |
5ae35c29 | 382 | sr_err("Unsupported baudrate: %d.", baudrate); |
b19f4622 | 383 | return SR_ERR; |
926b866c | 384 | } |
5ae35c29 UH |
385 | sr_spew("Configuring baudrate to %d (%d).", baudrate, dcb.BaudRate); |
386 | ||
5ddb0cc7 | 387 | sr_spew("Configuring %d data bits.", bits); |
926b866c | 388 | dcb.ByteSize = bits; |
5ddb0cc7 UH |
389 | |
390 | sr_spew("Configuring %d stop bits.", stopbits); | |
391 | switch (stopbits) { | |
392 | /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */ | |
393 | case 1: | |
394 | dcb.StopBits = ONESTOPBIT; | |
395 | break; | |
396 | case 2: | |
397 | dcb.StopBits = TWOSTOPBITS; | |
398 | break; | |
399 | default: | |
400 | sr_err("Unsupported stopbits number: %d.", stopbits); | |
401 | return SR_ERR; | |
402 | } | |
403 | ||
404 | switch (parity) { | |
405 | /* Note: There's also SPACEPARITY, MARKPARITY (unneeded so far). */ | |
406 | case SERIAL_PARITY_NONE: | |
407 | sr_spew("Configuring no parity."); | |
408 | dcb.Parity = NOPARITY; | |
409 | break; | |
410 | case SERIAL_PARITY_EVEN: | |
411 | sr_spew("Configuring even parity."); | |
412 | dcb.Parity = EVENPARITY; | |
413 | break; | |
414 | case SERIAL_PARITY_ODD: | |
415 | sr_spew("Configuring odd parity."); | |
416 | dcb.Parity = ODDPARITY; | |
417 | break; | |
418 | default: | |
419 | sr_err("Unsupported parity setting: %d.", parity); | |
420 | return SR_ERR; | |
421 | } | |
926b866c | 422 | |
39e5d798 UH |
423 | if (rts != -1) { |
424 | sr_spew("Setting RTS %s.", rts ? "high" : "low"); | |
425 | if (rts) | |
426 | dcb.fRtsControl = RTS_CONTROL_ENABLE; | |
427 | else | |
428 | dcb.fRtsControl = RTS_CONTROL_DISABLE; | |
429 | } | |
430 | ||
431 | if (dtr != -1) { | |
432 | sr_spew("Setting DTR %s.", dtr ? "high" : "low"); | |
433 | if (rts) | |
434 | dcb.fDtrControl = DTR_CONTROL_ENABLE; | |
435 | else | |
436 | dcb.fDtrControl = DTR_CONTROL_DISABLE; | |
437 | } | |
438 | ||
5ddb0cc7 UH |
439 | if (!SetCommState(hdl, &dcb)) { |
440 | sr_err("Failed to set comm state on port %s (fd %d): %d.", | |
441 | serial->port, serial->fd, GetLastError()); | |
e46b8fb1 | 442 | return SR_ERR; |
5ddb0cc7 | 443 | } |
926b866c | 444 | #else |
d02a535e | 445 | struct termios term; |
1ff7712c | 446 | speed_t baud; |
700dcd5c | 447 | int ret, controlbits; |
d02a535e | 448 | |
299bdb24 BV |
449 | if (tcgetattr(serial->fd, &term) < 0) { |
450 | sr_err("tcgetattr() error on port %s (fd %d): %s.", | |
451 | serial->port, serial->fd, strerror(errno)); | |
6a6e23ab | 452 | return SR_ERR; |
b19f4622 | 453 | } |
6a6e23ab | 454 | |
0abee507 | 455 | switch (baudrate) { |
b19f4622 UH |
456 | case 50: |
457 | baud = B50; | |
458 | break; | |
459 | case 75: | |
460 | baud = B75; | |
461 | break; | |
462 | case 110: | |
463 | baud = B110; | |
464 | break; | |
465 | case 134: | |
466 | baud = B134; | |
467 | break; | |
468 | case 150: | |
469 | baud = B150; | |
470 | break; | |
471 | case 200: | |
472 | baud = B200; | |
473 | break; | |
474 | case 300: | |
475 | baud = B300; | |
476 | break; | |
477 | case 600: | |
478 | baud = B600; | |
479 | break; | |
480 | case 1200: | |
481 | baud = B1200; | |
482 | break; | |
483 | case 1800: | |
484 | baud = B1800; | |
485 | break; | |
0f708301 AG |
486 | case 2400: |
487 | baud = B2400; | |
488 | break; | |
e8e9dcdd AG |
489 | case 4800: |
490 | baud = B4800; | |
491 | break; | |
1ff7712c DR |
492 | case 9600: |
493 | baud = B9600; | |
494 | break; | |
b19f4622 UH |
495 | case 19200: |
496 | baud = B19200; | |
497 | break; | |
1ff7712c DR |
498 | case 38400: |
499 | baud = B38400; | |
500 | break; | |
501 | case 57600: | |
502 | baud = B57600; | |
503 | break; | |
504 | case 115200: | |
505 | baud = B115200; | |
506 | break; | |
b19f4622 UH |
507 | case 230400: |
508 | baud = B230400; | |
509 | break; | |
9a751023 | 510 | #ifndef __APPLE__ |
1ff7712c DR |
511 | case 460800: |
512 | baud = B460800; | |
513 | break; | |
9a751023 | 514 | #endif |
1ff7712c | 515 | default: |
5ae35c29 | 516 | sr_err("Unsupported baudrate: %d.", baudrate); |
e46b8fb1 | 517 | return SR_ERR; |
1ff7712c | 518 | } |
b19f4622 | 519 | |
299bdb24 | 520 | sr_spew("Configuring output baudrate to %d (%d).", baudrate, baud); |
b19f4622 | 521 | if (cfsetospeed(&term, baud) < 0) { |
5df7b201 | 522 | sr_err("cfsetospeed() error: %s.", strerror(errno)); |
e46b8fb1 | 523 | return SR_ERR; |
b19f4622 UH |
524 | } |
525 | ||
299bdb24 | 526 | sr_spew("Configuring input baudrate to %d (%d).", baudrate, baud); |
b19f4622 | 527 | if (cfsetispeed(&term, baud) < 0) { |
5df7b201 | 528 | sr_err("cfsetispeed() error: %s.", strerror(errno)); |
e46b8fb1 | 529 | return SR_ERR; |
b19f4622 | 530 | } |
1ff7712c | 531 | |
299bdb24 | 532 | sr_spew("Configuring %d data bits.", bits); |
d02a535e | 533 | term.c_cflag &= ~CSIZE; |
1ff7712c DR |
534 | switch (bits) { |
535 | case 8: | |
536 | term.c_cflag |= CS8; | |
537 | break; | |
538 | case 7: | |
539 | term.c_cflag |= CS7; | |
540 | break; | |
541 | default: | |
299bdb24 | 542 | sr_err("Unsupported data bits number %d.", bits); |
e46b8fb1 | 543 | return SR_ERR; |
1ff7712c DR |
544 | } |
545 | ||
299bdb24 | 546 | sr_spew("Configuring %d stop bits.", stopbits); |
d02a535e | 547 | term.c_cflag &= ~CSTOPB; |
1ff7712c DR |
548 | switch (stopbits) { |
549 | case 1: | |
299bdb24 | 550 | term.c_cflag &= ~CSTOPB; |
1ff7712c DR |
551 | break; |
552 | case 2: | |
553 | term.c_cflag |= CSTOPB; | |
d7c776b9 | 554 | break; |
1ff7712c | 555 | default: |
299bdb24 | 556 | sr_err("Unsupported stopbits number %d.", stopbits); |
e46b8fb1 | 557 | return SR_ERR; |
1ff7712c DR |
558 | } |
559 | ||
f38b9763 BV |
560 | term.c_iflag &= ~(IXON | IXOFF); |
561 | term.c_cflag &= ~CRTSCTS; | |
1ff7712c | 562 | switch (flowcontrol) { |
f38b9763 BV |
563 | case 0: |
564 | /* No flow control. */ | |
299bdb24 | 565 | sr_spew("Configuring no flow control."); |
1ff7712c DR |
566 | break; |
567 | case 1: | |
299bdb24 | 568 | sr_spew("Configuring RTS/CTS flow control."); |
1ff7712c | 569 | term.c_cflag |= CRTSCTS; |
d7c776b9 | 570 | break; |
f38b9763 | 571 | case 2: |
299bdb24 | 572 | sr_spew("Configuring XON/XOFF flow control."); |
f38b9763 BV |
573 | term.c_iflag |= IXON | IXOFF; |
574 | break; | |
1ff7712c | 575 | default: |
299bdb24 | 576 | sr_err("Unsupported flow control setting %d.", flowcontrol); |
e46b8fb1 | 577 | return SR_ERR; |
1ff7712c DR |
578 | } |
579 | ||
ac4a2ea4 DR |
580 | term.c_iflag &= ~IGNPAR; |
581 | term.c_cflag &= ~(PARODD | PARENB); | |
1ff7712c | 582 | switch (parity) { |
f8c1fcda | 583 | case SERIAL_PARITY_NONE: |
299bdb24 | 584 | sr_spew("Configuring no parity."); |
1ff7712c DR |
585 | term.c_iflag |= IGNPAR; |
586 | break; | |
f8c1fcda | 587 | case SERIAL_PARITY_EVEN: |
299bdb24 | 588 | sr_spew("Configuring even parity."); |
ac4a2ea4 | 589 | term.c_cflag |= PARENB; |
1ff7712c | 590 | break; |
f8c1fcda | 591 | case SERIAL_PARITY_ODD: |
299bdb24 | 592 | sr_spew("Configuring odd parity."); |
ac4a2ea4 | 593 | term.c_cflag |= PARENB | PARODD; |
1ff7712c DR |
594 | break; |
595 | default: | |
299bdb24 | 596 | sr_err("Unsupported parity setting %d.", parity); |
e46b8fb1 | 597 | return SR_ERR; |
1ff7712c DR |
598 | } |
599 | ||
299bdb24 | 600 | /* Do not translate carriage return to newline on input. */ |
fb9d3bf9 | 601 | term.c_iflag &= ~(ICRNL); |
b19f4622 UH |
602 | |
603 | /* Disable canonical mode, and don't echo input characters. */ | |
5c51e098 BV |
604 | term.c_lflag &= ~(ICANON | ECHO); |
605 | ||
b19f4622 | 606 | /* Write the configured settings. */ |
299bdb24 BV |
607 | if (tcsetattr(serial->fd, TCSADRAIN, &term) < 0) { |
608 | sr_err("tcsetattr() error: %s.", strerror(errno)); | |
e46b8fb1 | 609 | return SR_ERR; |
b19f4622 | 610 | } |
700dcd5c | 611 | |
71caaad4 BV |
612 | if (rts != -1) { |
613 | sr_spew("Setting RTS %s.", rts ? "high" : "low"); | |
614 | controlbits = TIOCM_RTS; | |
615 | if ((ret = ioctl(serial->fd, rts ? TIOCMBIS : TIOCMBIC, | |
616 | &controlbits)) < 0) { | |
617 | sr_err("Error setting RTS: %s.", strerror(errno)); | |
618 | return SR_ERR; | |
619 | } | |
700dcd5c UH |
620 | } |
621 | ||
71caaad4 BV |
622 | if (dtr != -1) { |
623 | sr_spew("Setting DTR %s.", dtr ? "high" : "low"); | |
624 | controlbits = TIOCM_DTR; | |
625 | if ((ret = ioctl(serial->fd, dtr ? TIOCMBIS : TIOCMBIC, | |
626 | &controlbits)) < 0) { | |
627 | sr_err("Error setting DTR: %s.", strerror(errno)); | |
628 | return SR_ERR; | |
629 | } | |
700dcd5c | 630 | } |
700dcd5c | 631 | |
926b866c | 632 | #endif |
d02a535e | 633 | |
e46b8fb1 | 634 | return SR_OK; |
d02a535e | 635 | } |
792fc686 | 636 | |
299bdb24 BV |
637 | /** |
638 | * Set serial parameters for the specified serial port. | |
639 | * | |
640 | * @param serial Previously initialized serial port structure. | |
641 | * @param paramstr A serial communication parameters string, in the form | |
642 | * of <speed>/<data bits><parity><stopbits>, for example "9600/8n1" or | |
643 | * "600/7o2". | |
644 | * | |
645 | * @return SR_OK upon success, SR_ERR upon failure. | |
646 | */ | |
71caaad4 | 647 | #define SERIAL_COMM_SPEC "^(\\d+)/([78])([neo])([12])(.*)$" |
299bdb24 BV |
648 | SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial, |
649 | const char *paramstr) | |
792fc686 BV |
650 | { |
651 | GRegex *reg; | |
652 | GMatchInfo *match; | |
71caaad4 BV |
653 | int speed, databits, parity, stopbits, rts, dtr, i; |
654 | char *mstr, **opts, **kv; | |
792fc686 BV |
655 | |
656 | speed = databits = parity = stopbits = 0; | |
71caaad4 | 657 | rts = dtr = -1; |
792fc686 BV |
658 | reg = g_regex_new(SERIAL_COMM_SPEC, 0, 0, NULL); |
659 | if (g_regex_match(reg, paramstr, 0, &match)) { | |
660 | if ((mstr = g_match_info_fetch(match, 1))) | |
661 | speed = strtoul(mstr, NULL, 10); | |
662 | g_free(mstr); | |
663 | if ((mstr = g_match_info_fetch(match, 2))) | |
664 | databits = strtoul(mstr, NULL, 10); | |
665 | g_free(mstr); | |
666 | if ((mstr = g_match_info_fetch(match, 3))) { | |
667 | switch (mstr[0]) { | |
668 | case 'n': | |
669 | parity = SERIAL_PARITY_NONE; | |
670 | break; | |
671 | case 'e': | |
672 | parity = SERIAL_PARITY_EVEN; | |
673 | break; | |
674 | case 'o': | |
675 | parity = SERIAL_PARITY_ODD; | |
676 | break; | |
677 | } | |
678 | } | |
679 | g_free(mstr); | |
680 | if ((mstr = g_match_info_fetch(match, 4))) | |
681 | stopbits = strtoul(mstr, NULL, 10); | |
682 | g_free(mstr); | |
71caaad4 BV |
683 | if ((mstr = g_match_info_fetch(match, 5)) && mstr[0] != '\0') { |
684 | if (mstr[0] != '/') { | |
685 | sr_dbg("missing separator before extra options"); | |
686 | speed = 0; | |
687 | } else { | |
688 | /* A set of "key=value" options separated by / */ | |
689 | opts = g_strsplit(mstr + 1, "/", 0); | |
690 | for (i = 0; opts[i]; i++) { | |
691 | kv = g_strsplit(opts[i], "=", 2); | |
692 | if (!strncmp(kv[0], "rts", 3)) { | |
693 | if (kv[1][0] == '1') | |
694 | rts = 1; | |
695 | else if (kv[1][0] == '0') | |
696 | rts = 0; | |
697 | else { | |
698 | sr_dbg("invalid value for rts: %c", kv[1][0]); | |
699 | speed = 0; | |
700 | } | |
701 | } else if (!strncmp(kv[0], "dtr", 3)) { | |
702 | if (kv[1][0] == '1') | |
703 | dtr = 1; | |
704 | else if (kv[1][0] == '0') | |
705 | dtr = 0; | |
706 | else { | |
707 | sr_dbg("invalid value for dtr: %c", kv[1][0]); | |
708 | speed = 0; | |
709 | } | |
710 | } | |
711 | g_strfreev(kv); | |
712 | } | |
713 | g_strfreev(opts); | |
714 | } | |
715 | } | |
716 | g_free(mstr); | |
792fc686 BV |
717 | } |
718 | g_match_info_unref(match); | |
719 | g_regex_unref(reg); | |
720 | ||
721 | if (speed) | |
71caaad4 BV |
722 | return serial_set_params(serial, speed, databits, parity, stopbits, |
723 | 0, rts, dtr); | |
792fc686 BV |
724 | else |
725 | return SR_ERR_ARG; | |
726 | } | |
727 | ||
299bdb24 BV |
728 | /** |
729 | * Read a line from the specified serial port. | |
730 | * | |
731 | * @param serial Previously initialized serial port structure. | |
732 | * @param buf Buffer where to store the bytes that are read. | |
733 | * @param buflen Size of the buffer. | |
734 | * @param timeout_ms How long to wait for a line to come in. | |
735 | * | |
736 | * Reading stops when CR of LR is found, which is stripped from the buffer. | |
737 | * | |
738 | * @return SR_OK on success, SR_ERR on failure. | |
739 | */ | |
740 | SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf, | |
741 | int *buflen, gint64 timeout_ms) | |
6f22a8ef | 742 | { |
b87f8504 | 743 | gint64 start; |
6f22a8ef UH |
744 | int maxlen, len; |
745 | ||
299bdb24 BV |
746 | if (!serial || serial->fd == -1) { |
747 | sr_dbg("Invalid serial port."); | |
748 | return SR_ERR; | |
749 | } | |
750 | ||
751 | if (serial->fd == -1) { | |
752 | sr_dbg("Cannot use unopened serial port %s (fd %d).", | |
753 | serial->port, serial->fd); | |
754 | return -1; | |
755 | } | |
756 | ||
6f22a8ef UH |
757 | timeout_ms *= 1000; |
758 | start = g_get_monotonic_time(); | |
759 | ||
760 | maxlen = *buflen; | |
761 | *buflen = len = 0; | |
762 | while(1) { | |
763 | len = maxlen - *buflen - 1; | |
764 | if (len < 1) | |
765 | break; | |
299bdb24 | 766 | len = serial_read(serial, *buf + *buflen, 1); |
6f22a8ef UH |
767 | if (len > 0) { |
768 | *buflen += len; | |
769 | *(*buf + *buflen) = '\0'; | |
318dd53c BV |
770 | if (*buflen > 0 && (*(*buf + *buflen - 1) == '\r' |
771 | || *(*buf + *buflen - 1) == '\n')) { | |
772 | /* Strip CR/LF and terminate. */ | |
6f22a8ef UH |
773 | *(*buf + --*buflen) = '\0'; |
774 | break; | |
775 | } | |
776 | } | |
777 | if (g_get_monotonic_time() - start > timeout_ms) | |
778 | /* Timeout */ | |
779 | break; | |
780 | g_usleep(2000); | |
781 | } | |
318dd53c BV |
782 | if (*buflen) |
783 | sr_dbg("Received %d: '%s'.", *buflen, *buf); | |
6f22a8ef UH |
784 | |
785 | return SR_OK; | |
786 | } | |
766456be UH |
787 | |
788 | /** | |
789 | * Try to find a valid packet in a serial data stream. | |
790 | * | |
791 | * @param serial Previously initialized serial port structure. | |
792 | * @param buf Buffer containing the bytes to write. | |
793 | * @param count Size of the buffer. | |
794 | * @param packet_size Size, in bytes, of a valid packet. | |
795 | * @param is_valid Callback that assesses whether the packet is valid or not. | |
796 | * @param timeout_ms The timeout after which, if no packet is detected, to | |
797 | * abort scanning. | |
798 | * @param baudrate The baudrate of the serial port. This parameter is not | |
799 | * critical, but it helps fine tune the serial port polling | |
800 | * delay. | |
801 | * | |
802 | * @return SR_OK if a valid packet is found within the given timeout, | |
803 | * SR_ERR upon failure. | |
804 | */ | |
805 | SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial, | |
806 | uint8_t *buf, size_t *buflen, | |
807 | size_t packet_size, packet_valid_t is_valid, | |
808 | uint64_t timeout_ms, int baudrate) | |
809 | { | |
810 | uint64_t start, time, byte_delay_us; | |
811 | size_t ibuf, i, maxlen; | |
812 | int len; | |
813 | ||
814 | maxlen = *buflen; | |
815 | ||
816 | sr_dbg("Detecting packets on FD %d (timeout = %" PRIu64 | |
817 | "ms, baudrate = %d).", serial->fd, timeout_ms, baudrate); | |
818 | ||
819 | if (maxlen < (packet_size / 2) ) { | |
820 | sr_err("Buffer size must be at least twice the packet size."); | |
821 | return SR_ERR; | |
822 | } | |
823 | ||
766456be UH |
824 | /* Assume 8n1 transmission. That is 10 bits for every byte. */ |
825 | byte_delay_us = 10 * (1000000 / baudrate); | |
826 | start = g_get_monotonic_time(); | |
827 | ||
828 | i = ibuf = len = 0; | |
829 | while (ibuf < maxlen) { | |
830 | len = serial_read(serial, &buf[ibuf], 1); | |
831 | if (len > 0) { | |
832 | ibuf += len; | |
833 | } else if (len == 0) { | |
834 | sr_spew("Error: Only read 0 bytes."); | |
835 | } else { | |
836 | /* Error reading byte, but continuing anyway. */ | |
837 | } | |
551c3d8c AG |
838 | |
839 | time = g_get_monotonic_time() - start; | |
840 | time /= 1000; | |
841 | ||
766456be UH |
842 | if ((ibuf - i) >= packet_size) { |
843 | /* We have at least a packet's worth of data. */ | |
844 | if (is_valid(&buf[i])) { | |
766456be UH |
845 | sr_spew("Found valid %d-byte packet after " |
846 | "%" PRIu64 "ms.", (ibuf - i), time); | |
847 | *buflen = ibuf; | |
848 | return SR_OK; | |
849 | } else { | |
850 | sr_spew("Got %d bytes, but not a valid " | |
851 | "packet.", (ibuf - i)); | |
852 | } | |
853 | /* Not a valid packet. Continue searching. */ | |
854 | i++; | |
855 | } | |
551c3d8c | 856 | if (time >= timeout_ms) { |
766456be | 857 | /* Timeout */ |
551c3d8c | 858 | sr_dbg("Detection timed out after %dms.", time); |
766456be UH |
859 | break; |
860 | } | |
861 | g_usleep(byte_delay_us); | |
862 | } | |
863 | ||
864 | *buflen = ibuf; | |
865 | ||
866 | sr_err("Didn't find a valid packet (read %d bytes).", *buflen); | |
867 | ||
868 | return SR_ERR; | |
869 | } |