]> sigrok.org Git - libserialport.git/blame_incremental - serialport.c
projects / libserialport.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Apply a default baudrate when the OS does not provide one.
[libserialport.git] / serialport.c
... / ...
CommitLineData
1/*
2 * This file is part of the libserialport project.
3 *
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2010-2015 Uwe Hermann <uwe@hermann-uwe.de>
6 * Copyright (C) 2013-2015 Martin Ling <martin-libserialport@earth.li>
7 * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
8 * Copyright (C) 2014 Aurelien Jacobs <aurel@gnuage.org>
9 *
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Lesser General Public License as
12 * published by the Free Software Foundation, either version 3 of the
13 * License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 */
23
24#include "libserialport_internal.h"
25
26static const struct std_baudrate std_baudrates[] = {
27#ifdef _WIN32
28 /*
29 * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
30 * have documented CBR_* macros.
31 */
32 BAUD(110), BAUD(300), BAUD(600), BAUD(1200), BAUD(2400), BAUD(4800),
33 BAUD(9600), BAUD(14400), BAUD(19200), BAUD(38400), BAUD(57600),
34 BAUD(115200), BAUD(128000), BAUD(256000),
35#else
36 BAUD(50), BAUD(75), BAUD(110), BAUD(134), BAUD(150), BAUD(200),
37 BAUD(300), BAUD(600), BAUD(1200), BAUD(1800), BAUD(2400), BAUD(4800),
38 BAUD(9600), BAUD(19200), BAUD(38400), BAUD(57600), BAUD(115200),
39 BAUD(230400),
40#if !defined(__APPLE__) && !defined(__OpenBSD__)
41 BAUD(460800),
42#endif
43#endif
44};
45
46#define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates)
47
48void (*sp_debug_handler)(const char *format, ...) = sp_default_debug_handler;
49
50static enum sp_return get_config(struct sp_port *port, struct port_data *data,
51 struct sp_port_config *config);
52
53static enum sp_return set_config(struct sp_port *port, struct port_data *data,
54 const struct sp_port_config *config);
55
56SP_API enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
57{
58 struct sp_port *port;
59#ifndef NO_PORT_METADATA
60 enum sp_return ret;
61#endif
62 size_t len;
63
64 TRACE("%s, %p", portname, port_ptr);
65
66 if (!port_ptr)
67 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
68
69 *port_ptr = NULL;
70
71 if (!portname)
72 RETURN_ERROR(SP_ERR_ARG, "Null port name");
73
74 DEBUG_FMT("Building structure for port %s", portname);
75
76#if !defined(_WIN32) && defined(HAVE_REALPATH)
77 /*
78 * get_port_details() below tries to be too smart and figure out
79 * some transport properties from the port name which breaks with
80 * symlinks. Therefore we canonicalize the portname first.
81 */
82 char pathbuf[PATH_MAX + 1];
83 char *res = realpath(portname, pathbuf);
84 if (!res)
85 RETURN_ERROR(SP_ERR_ARG, "Could not retrieve realpath behind port name");
86
87 portname = pathbuf;
88#endif
89
90 if (!(port = malloc(sizeof(struct sp_port))))
91 RETURN_ERROR(SP_ERR_MEM, "Port structure malloc failed");
92
93 len = strlen(portname) + 1;
94
95 if (!(port->name = malloc(len))) {
96 free(port);
97 RETURN_ERROR(SP_ERR_MEM, "Port name malloc failed");
98 }
99
100 memcpy(port->name, portname, len);
101
102#ifdef _WIN32
103 port->usb_path = NULL;
104 port->hdl = INVALID_HANDLE_VALUE;
105 port->write_buf = NULL;
106 port->write_buf_size = 0;
107#else
108 port->fd = -1;
109#endif
110
111 port->description = NULL;
112 port->transport = SP_TRANSPORT_NATIVE;
113 port->usb_bus = -1;
114 port->usb_address = -1;
115 port->usb_vid = -1;
116 port->usb_pid = -1;
117 port->usb_manufacturer = NULL;
118 port->usb_product = NULL;
119 port->usb_serial = NULL;
120 port->bluetooth_address = NULL;
121
122#ifndef NO_PORT_METADATA
123 if ((ret = get_port_details(port)) != SP_OK) {
124 sp_free_port(port);
125 return ret;
126 }
127#endif
128
129 *port_ptr = port;
130
131 RETURN_OK();
132}
133
134SP_API char *sp_get_port_name(const struct sp_port *port)
135{
136 TRACE("%p", port);
137
138 if (!port)
139 return NULL;
140
141 RETURN_STRING(port->name);
142}
143
144SP_API char *sp_get_port_description(const struct sp_port *port)
145{
146 TRACE("%p", port);
147
148 if (!port || !port->description)
149 return NULL;
150
151 RETURN_STRING(port->description);
152}
153
154SP_API enum sp_transport sp_get_port_transport(const struct sp_port *port)
155{
156 TRACE("%p", port);
157
158 RETURN_INT(port ? port->transport : SP_TRANSPORT_NATIVE);
159}
160
161SP_API enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
162 int *usb_bus,int *usb_address)
163{
164 TRACE("%p", port);
165
166 if (!port)
167 RETURN_ERROR(SP_ERR_ARG, "Null port");
168 if (port->transport != SP_TRANSPORT_USB)
169 RETURN_ERROR(SP_ERR_ARG, "Port does not use USB transport");
170 if (port->usb_bus < 0 || port->usb_address < 0)
171 RETURN_ERROR(SP_ERR_SUPP, "Bus and address values are not available");
172
173 if (usb_bus)
174 *usb_bus = port->usb_bus;
175 if (usb_address)
176 *usb_address = port->usb_address;
177
178 RETURN_OK();
179}
180
181SP_API enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port,
182 int *usb_vid, int *usb_pid)
183{
184 TRACE("%p", port);
185
186 if (!port)
187 RETURN_ERROR(SP_ERR_ARG, "Null port");
188 if (port->transport != SP_TRANSPORT_USB)
189 RETURN_ERROR(SP_ERR_ARG, "Port does not use USB transport");
190 if (port->usb_vid < 0 || port->usb_pid < 0)
191 RETURN_ERROR(SP_ERR_SUPP, "VID:PID values are not available");
192
193 if (usb_vid)
194 *usb_vid = port->usb_vid;
195 if (usb_pid)
196 *usb_pid = port->usb_pid;
197
198 RETURN_OK();
199}
200
201SP_API char *sp_get_port_usb_manufacturer(const struct sp_port *port)
202{
203 TRACE("%p", port);
204
205 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_manufacturer)
206 return NULL;
207
208 RETURN_STRING(port->usb_manufacturer);
209}
210
211SP_API char *sp_get_port_usb_product(const struct sp_port *port)
212{
213 TRACE("%p", port);
214
215 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_product)
216 return NULL;
217
218 RETURN_STRING(port->usb_product);
219}
220
221SP_API char *sp_get_port_usb_serial(const struct sp_port *port)
222{
223 TRACE("%p", port);
224
225 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_serial)
226 return NULL;
227
228 RETURN_STRING(port->usb_serial);
229}
230
231SP_API char *sp_get_port_bluetooth_address(const struct sp_port *port)
232{
233 TRACE("%p", port);
234
235 if (!port || port->transport != SP_TRANSPORT_BLUETOOTH
236 || !port->bluetooth_address)
237 return NULL;
238
239 RETURN_STRING(port->bluetooth_address);
240}
241
242SP_API enum sp_return sp_get_port_handle(const struct sp_port *port,
243 void *result_ptr)
244{
245 TRACE("%p, %p", port, result_ptr);
246
247 if (!port)
248 RETURN_ERROR(SP_ERR_ARG, "Null port");
249 if (!result_ptr)
250 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
251
252#ifdef _WIN32
253 HANDLE *handle_ptr = result_ptr;
254 *handle_ptr = port->hdl;
255#else
256 int *fd_ptr = result_ptr;
257 *fd_ptr = port->fd;
258#endif
259
260 RETURN_OK();
261}
262
263SP_API enum sp_return sp_copy_port(const struct sp_port *port,
264 struct sp_port **copy_ptr)
265{
266 TRACE("%p, %p", port, copy_ptr);
267
268 if (!copy_ptr)
269 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
270
271 *copy_ptr = NULL;
272
273 if (!port)
274 RETURN_ERROR(SP_ERR_ARG, "Null port");
275
276 if (!port->name)
277 RETURN_ERROR(SP_ERR_ARG, "Null port name");
278
279 DEBUG("Copying port structure");
280
281 RETURN_INT(sp_get_port_by_name(port->name, copy_ptr));
282}
283
284SP_API void sp_free_port(struct sp_port *port)
285{
286 TRACE("%p", port);
287
288 if (!port) {
289 DEBUG("Null port");
290 RETURN();
291 }
292
293 DEBUG("Freeing port structure");
294
295 if (port->name)
296 free(port->name);
297 if (port->description)
298 free(port->description);
299 if (port->usb_manufacturer)
300 free(port->usb_manufacturer);
301 if (port->usb_product)
302 free(port->usb_product);
303 if (port->usb_serial)
304 free(port->usb_serial);
305 if (port->bluetooth_address)
306 free(port->bluetooth_address);
307#ifdef _WIN32
308 if (port->usb_path)
309 free(port->usb_path);
310 if (port->write_buf)
311 free(port->write_buf);
312#endif
313
314 free(port);
315
316 RETURN();
317}
318
319SP_PRIV struct sp_port **list_append(struct sp_port **list,
320 const char *portname)
321{
322 void *tmp;
323 size_t count;
324
325 for (count = 0; list[count]; count++)
326 ;
327 if (!(tmp = realloc(list, sizeof(struct sp_port *) * (count + 2))))
328 goto fail;
329 list = tmp;
330 if (sp_get_port_by_name(portname, &list[count]) != SP_OK)
331 goto fail;
332 list[count + 1] = NULL;
333 return list;
334
335fail:
336 sp_free_port_list(list);
337 return NULL;
338}
339
340SP_API enum sp_return sp_list_ports(struct sp_port ***list_ptr)
341{
342#ifndef NO_ENUMERATION
343 struct sp_port **list;
344 int ret;
345#endif
346
347 TRACE("%p", list_ptr);
348
349 if (!list_ptr)
350 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
351
352 *list_ptr = NULL;
353
354#ifdef NO_ENUMERATION
355 RETURN_ERROR(SP_ERR_SUPP, "Enumeration not supported on this platform");
356#else
357 DEBUG("Enumerating ports");
358
359 if (!(list = malloc(sizeof(struct sp_port *))))
360 RETURN_ERROR(SP_ERR_MEM, "Port list malloc failed");
361
362 list[0] = NULL;
363
364 ret = list_ports(&list);
365
366 if (ret == SP_OK) {
367 *list_ptr = list;
368 } else {
369 sp_free_port_list(list);
370 *list_ptr = NULL;
371 }
372
373 RETURN_CODEVAL(ret);
374#endif
375}
376
377SP_API void sp_free_port_list(struct sp_port **list)
378{
379 unsigned int i;
380
381 TRACE("%p", list);
382
383 if (!list) {
384 DEBUG("Null list");
385 RETURN();
386 }
387
388 DEBUG("Freeing port list");
389
390 for (i = 0; list[i]; i++)
391 sp_free_port(list[i]);
392 free(list);
393
394 RETURN();
395}
396
397#define CHECK_PORT() do { \
398 if (!port) \
399 RETURN_ERROR(SP_ERR_ARG, "Null port"); \
400 if (!port->name) \
401 RETURN_ERROR(SP_ERR_ARG, "Null port name"); \
402} while (0)
403#ifdef _WIN32
404#define CHECK_PORT_HANDLE() do { \
405 if (port->hdl == INVALID_HANDLE_VALUE) \
406 RETURN_ERROR(SP_ERR_ARG, "Port not open"); \
407} while (0)
408#else
409#define CHECK_PORT_HANDLE() do { \
410 if (port->fd < 0) \
411 RETURN_ERROR(SP_ERR_ARG, "Port not open"); \
412} while (0)
413#endif
414#define CHECK_OPEN_PORT() do { \
415 CHECK_PORT(); \
416 CHECK_PORT_HANDLE(); \
417} while (0)
418
419#ifdef WIN32
420/** To be called after port receive buffer is emptied. */
421static enum sp_return restart_wait(struct sp_port *port)
422{
423 DWORD wait_result;
424
425 if (port->wait_running) {
426 /* Check status of running wait operation. */
427 if (GetOverlappedResult(port->hdl, &port->wait_ovl,
428 &wait_result, FALSE)) {
429 DEBUG("Previous wait completed");
430 port->wait_running = FALSE;
431 } else if (GetLastError() == ERROR_IO_INCOMPLETE) {
432 DEBUG("Previous wait still running");
433 RETURN_OK();
434 } else {
435 RETURN_FAIL("GetOverlappedResult() failed");
436 }
437 }
438
439 if (!port->wait_running) {
440 /* Start new wait operation. */
441 if (WaitCommEvent(port->hdl, &port->events,
442 &port->wait_ovl)) {
443 DEBUG("New wait returned, events already pending");
444 } else if (GetLastError() == ERROR_IO_PENDING) {
445 DEBUG("New wait running in background");
446 port->wait_running = TRUE;
447 } else {
448 RETURN_FAIL("WaitCommEvent() failed");
449 }
450 }
451
452 RETURN_OK();
453}
454#endif
455
456SP_API enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
457{
458 struct port_data data;
459 struct sp_port_config config;
460 enum sp_return ret;
461
462 TRACE("%p, 0x%x", port, flags);
463
464 CHECK_PORT();
465
466 if (flags > SP_MODE_READ_WRITE)
467 RETURN_ERROR(SP_ERR_ARG, "Invalid flags");
468
469 DEBUG_FMT("Opening port %s", port->name);
470
471#ifdef _WIN32
472 DWORD desired_access = 0, flags_and_attributes = 0, errors;
473 char *escaped_port_name;
474 COMSTAT status;
475
476 /* Prefix port name with '\\.\' to work with ports above COM9. */
477 if (!(escaped_port_name = malloc(strlen(port->name) + 5)))
478 RETURN_ERROR(SP_ERR_MEM, "Escaped port name malloc failed");
479 sprintf(escaped_port_name, "\\\\.\\%s", port->name);
480
481 /* Map 'flags' to the OS-specific settings. */
482 flags_and_attributes = FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED;
483 if (flags & SP_MODE_READ)
484 desired_access |= GENERIC_READ;
485 if (flags & SP_MODE_WRITE)
486 desired_access |= GENERIC_WRITE;
487
488 port->hdl = CreateFileA(escaped_port_name, desired_access, 0, 0,
489 OPEN_EXISTING, flags_and_attributes, 0);
490
491 free(escaped_port_name);
492
493 if (port->hdl == INVALID_HANDLE_VALUE)
494 RETURN_FAIL("Port CreateFile() failed");
495
496 /* All timeouts initially disabled. */
497 port->timeouts.ReadIntervalTimeout = 0;
498 port->timeouts.ReadTotalTimeoutMultiplier = 0;
499 port->timeouts.ReadTotalTimeoutConstant = 0;
500 port->timeouts.WriteTotalTimeoutMultiplier = 0;
501 port->timeouts.WriteTotalTimeoutConstant = 0;
502
503 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0) {
504 sp_close(port);
505 RETURN_FAIL("SetCommTimeouts() failed");
506 }
507
508 /* Prepare OVERLAPPED structures. */
509#define INIT_OVERLAPPED(ovl) do { \
510 memset(&port->ovl, 0, sizeof(port->ovl)); \
511 port->ovl.hEvent = INVALID_HANDLE_VALUE; \
512 if ((port->ovl.hEvent = CreateEvent(NULL, TRUE, TRUE, NULL)) \
513 == INVALID_HANDLE_VALUE) { \
514 sp_close(port); \
515 RETURN_FAIL(#ovl "CreateEvent() failed"); \
516 } \
517} while (0)
518
519 INIT_OVERLAPPED(read_ovl);
520 INIT_OVERLAPPED(write_ovl);
521 INIT_OVERLAPPED(wait_ovl);
522
523 /* Set event mask for RX and error events. */
524 if (SetCommMask(port->hdl, EV_RXCHAR | EV_ERR) == 0) {
525 sp_close(port);
526 RETURN_FAIL("SetCommMask() failed");
527 }
528
529 port->writing = FALSE;
530 port->wait_running = FALSE;
531
532 ret = restart_wait(port);
533
534 if (ret < 0) {
535 sp_close(port);
536 RETURN_CODEVAL(ret);
537 }
538#else
539 int flags_local = O_NONBLOCK | O_NOCTTY | O_CLOEXEC;
540
541 /* Map 'flags' to the OS-specific settings. */
542 if ((flags & SP_MODE_READ_WRITE) == SP_MODE_READ_WRITE)
543 flags_local |= O_RDWR;
544 else if (flags & SP_MODE_READ)
545 flags_local |= O_RDONLY;
546 else if (flags & SP_MODE_WRITE)
547 flags_local |= O_WRONLY;
548
549 if ((port->fd = open(port->name, flags_local)) < 0)
550 RETURN_FAIL("open() failed");
551
552 /*
553 * On POSIX in the default case the file descriptor of a serial port
554 * is not opened exclusively. Therefore the settings of a port are
555 * overwritten if the serial port is opened a second time. Windows
556 * opens all serial ports exclusively.
557 * So the idea is to open the serial ports alike in the exclusive mode.
558 *
559 * ioctl(*, TIOCEXCL) defines the file descriptor as exclusive. So all
560 * further open calls on the serial port will fail.
561 *
562 * There is a race condition if two processes open the same serial
563 * port. None of the processes will notice the exclusive ownership of
564 * the other process because ioctl() doesn't return an error code if
565 * the file descriptor is already marked as exclusive.
566 * This can be solved with flock(). It returns an error if the file
567 * descriptor is already locked by another process.
568 */
569#ifdef HAVE_FLOCK
570 if (flock(port->fd, LOCK_EX | LOCK_NB) < 0)
571 RETURN_FAIL("flock() failed");
572#endif
573
574#ifdef TIOCEXCL
575 /*
576 * Before Linux 3.8 ioctl(*, TIOCEXCL) was not implemented and could
577 * lead to EINVAL or ENOTTY.
578 * These errors aren't fatal and can be ignored.
579 */
580 if (ioctl(port->fd, TIOCEXCL) < 0 && errno != EINVAL && errno != ENOTTY)
581 RETURN_FAIL("ioctl() failed");
582#endif
583
584#endif
585
586 ret = get_config(port, &data, &config);
587
588 if (ret < 0) {
589 sp_close(port);
590 RETURN_CODEVAL(ret);
591 }
592
593 /*
594 * Assume a default baudrate if the OS does not provide one.
595 * Cannot assign -1 here since Windows holds the baudrate in
596 * the DCB and does not configure the rate individually.
597 */
598 if (config.baudrate == 0) {
599 config.baudrate = 9600;
600 }
601
602 /* Set sane port settings. */
603#ifdef _WIN32
604 data.dcb.fBinary = TRUE;
605 data.dcb.fDsrSensitivity = FALSE;
606 data.dcb.fErrorChar = FALSE;
607 data.dcb.fNull = FALSE;
608 data.dcb.fAbortOnError = FALSE;
609#else
610 /* Turn off all fancy termios tricks, give us a raw channel. */
611 data.term.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP | INLCR | IGNCR | ICRNL | IMAXBEL);
612#ifdef IUCLC
613 data.term.c_iflag &= ~IUCLC;
614#endif
615 data.term.c_oflag &= ~(OPOST | ONLCR | OCRNL | ONOCR | ONLRET);
616#ifdef OLCUC
617 data.term.c_oflag &= ~OLCUC;
618#endif
619#ifdef NLDLY
620 data.term.c_oflag &= ~NLDLY;
621#endif
622#ifdef CRDLY
623 data.term.c_oflag &= ~CRDLY;
624#endif
625#ifdef TABDLY
626 data.term.c_oflag &= ~TABDLY;
627#endif
628#ifdef BSDLY
629 data.term.c_oflag &= ~BSDLY;
630#endif
631#ifdef VTDLY
632 data.term.c_oflag &= ~VTDLY;
633#endif
634#ifdef FFDLY
635 data.term.c_oflag &= ~FFDLY;
636#endif
637#ifdef OFILL
638 data.term.c_oflag &= ~OFILL;
639#endif
640 data.term.c_lflag &= ~(ISIG | ICANON | ECHO | IEXTEN);
641 data.term.c_cc[VMIN] = 0;
642 data.term.c_cc[VTIME] = 0;
643
644 /* Ignore modem status lines; enable receiver; leave control lines alone on close. */
645 data.term.c_cflag |= (CLOCAL | CREAD);
646 data.term.c_cflag &= ~(HUPCL);
647#endif
648
649#ifdef _WIN32
650 if (ClearCommError(port->hdl, &errors, &status) == 0)
651 RETURN_FAIL("ClearCommError() failed");
652#endif
653
654 ret = set_config(port, &data, &config);
655
656 if (ret < 0) {
657 sp_close(port);
658 RETURN_CODEVAL(ret);
659 }
660
661 RETURN_OK();
662}
663
664SP_API enum sp_return sp_close(struct sp_port *port)
665{
666 TRACE("%p", port);
667
668 CHECK_OPEN_PORT();
669
670 DEBUG_FMT("Closing port %s", port->name);
671
672#ifdef _WIN32
673 /* Returns non-zero upon success, 0 upon failure. */
674 if (CloseHandle(port->hdl) == 0)
675 RETURN_FAIL("Port CloseHandle() failed");
676 port->hdl = INVALID_HANDLE_VALUE;
677
678 /* Close event handles for overlapped structures. */
679#define CLOSE_OVERLAPPED(ovl) do { \
680 if (port->ovl.hEvent != INVALID_HANDLE_VALUE && \
681 CloseHandle(port->ovl.hEvent) == 0) \
682 RETURN_FAIL(# ovl "event CloseHandle() failed"); \
683} while (0)
684 CLOSE_OVERLAPPED(read_ovl);
685 CLOSE_OVERLAPPED(write_ovl);
686 CLOSE_OVERLAPPED(wait_ovl);
687
688 if (port->write_buf) {
689 free(port->write_buf);
690 port->write_buf = NULL;
691 }
692#else
693 /* Returns 0 upon success, -1 upon failure. */
694 if (close(port->fd) == -1)
695 RETURN_FAIL("close() failed");
696 port->fd = -1;
697#endif
698
699 RETURN_OK();
700}
701
702SP_API enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers)
703{
704 TRACE("%p, 0x%x", port, buffers);
705
706 CHECK_OPEN_PORT();
707
708 if (buffers > SP_BUF_BOTH)
709 RETURN_ERROR(SP_ERR_ARG, "Invalid buffer selection");
710
711 const char *buffer_names[] = {"no", "input", "output", "both"};
712
713 DEBUG_FMT("Flushing %s buffers on port %s",
714 buffer_names[buffers], port->name);
715
716#ifdef _WIN32
717 DWORD flags = 0;
718 if (buffers & SP_BUF_INPUT)
719 flags |= PURGE_RXCLEAR;
720 if (buffers & SP_BUF_OUTPUT)
721 flags |= PURGE_TXCLEAR;
722
723 /* Returns non-zero upon success, 0 upon failure. */
724 if (PurgeComm(port->hdl, flags) == 0)
725 RETURN_FAIL("PurgeComm() failed");
726
727 if (buffers & SP_BUF_INPUT)
728 TRY(restart_wait(port));
729#else
730 int flags = 0;
731 if (buffers == SP_BUF_BOTH)
732 flags = TCIOFLUSH;
733 else if (buffers == SP_BUF_INPUT)
734 flags = TCIFLUSH;
735 else if (buffers == SP_BUF_OUTPUT)
736 flags = TCOFLUSH;
737
738 /* Returns 0 upon success, -1 upon failure. */
739 if (tcflush(port->fd, flags) < 0)
740 RETURN_FAIL("tcflush() failed");
741#endif
742 RETURN_OK();
743}
744
745SP_API enum sp_return sp_drain(struct sp_port *port)
746{
747 TRACE("%p", port);
748
749 CHECK_OPEN_PORT();
750
751 DEBUG_FMT("Draining port %s", port->name);
752
753#ifdef _WIN32
754 /* Returns non-zero upon success, 0 upon failure. */
755 if (FlushFileBuffers(port->hdl) == 0)
756 RETURN_FAIL("FlushFileBuffers() failed");
757 RETURN_OK();
758#else
759 int result;
760 while (1) {
761#if defined(__ANDROID__) && (__ANDROID_API__ < 21)
762 /* Android only has tcdrain from platform 21 onwards.
763 * On previous API versions, use the ioctl directly. */
764 int arg = 1;
765 result = ioctl(port->fd, TCSBRK, &arg);
766#else
767 result = tcdrain(port->fd);
768#endif
769 if (result < 0) {
770 if (errno == EINTR) {
771 DEBUG("tcdrain() was interrupted");
772 continue;
773 } else {
774 RETURN_FAIL("tcdrain() failed");
775 }
776 } else {
777 RETURN_OK();
778 }
779 }
780#endif
781}
782
783#ifdef _WIN32
784static enum sp_return await_write_completion(struct sp_port *port)
785{
786 TRACE("%p", port);
787 DWORD bytes_written;
788 BOOL result;
789
790 /* Wait for previous non-blocking write to complete, if any. */
791 if (port->writing) {
792 DEBUG("Waiting for previous write to complete");
793 result = GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE);
794 port->writing = 0;
795 if (!result)
796 RETURN_FAIL("Previous write failed to complete");
797 DEBUG("Previous write completed");
798 }
799
800 RETURN_OK();
801}
802#endif
803
804SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
805 size_t count, unsigned int timeout_ms)
806{
807 TRACE("%p, %p, %d, %d", port, buf, count, timeout_ms);
808
809 CHECK_OPEN_PORT();
810
811 if (!buf)
812 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
813
814 if (timeout_ms)
815 DEBUG_FMT("Writing %d bytes to port %s, timeout %d ms",
816 count, port->name, timeout_ms);
817 else
818 DEBUG_FMT("Writing %d bytes to port %s, no timeout",
819 count, port->name);
820
821 if (count == 0)
822 RETURN_INT(0);
823
824#ifdef _WIN32
825 DWORD remaining_ms, write_size, bytes_written;
826 size_t remaining_bytes, total_bytes_written = 0;
827 const uint8_t *write_ptr = (uint8_t *) buf;
828 bool result;
829 struct timeout timeout;
830
831 timeout_start(&timeout, timeout_ms);
832
833 TRY(await_write_completion(port));
834
835 while (total_bytes_written < count) {
836
837 if (timeout_check(&timeout))
838 break;
839
840 remaining_ms = timeout_remaining_ms(&timeout);
841
842 if (port->timeouts.WriteTotalTimeoutConstant != remaining_ms) {
843 port->timeouts.WriteTotalTimeoutConstant = remaining_ms;
844 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
845 RETURN_FAIL("SetCommTimeouts() failed");
846 }
847
848 /* Reduce write size if it exceeds the WriteFile limit. */
849 remaining_bytes = count - total_bytes_written;
850 if (remaining_bytes > WRITEFILE_MAX_SIZE)
851 write_size = WRITEFILE_MAX_SIZE;
852 else
853 write_size = (DWORD) remaining_bytes;
854
855 /* Start write. */
856
857 result = WriteFile(port->hdl, write_ptr, write_size, NULL, &port->write_ovl);
858
859 timeout_update(&timeout);
860
861 if (result) {
862 DEBUG("Write completed immediately");
863 bytes_written = write_size;
864 } else if (GetLastError() == ERROR_IO_PENDING) {
865 DEBUG("Waiting for write to complete");
866 if (GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE) == 0) {
867 if (GetLastError() == ERROR_SEM_TIMEOUT) {
868 DEBUG("Write timed out");
869 break;
870 } else {
871 RETURN_FAIL("GetOverlappedResult() failed");
872 }
873 }
874 DEBUG_FMT("Write completed, %d/%d bytes written", bytes_written, write_size);
875 } else {
876 RETURN_FAIL("WriteFile() failed");
877 }
878
879 write_ptr += bytes_written;
880 total_bytes_written += bytes_written;
881 }
882
883 RETURN_INT((int) total_bytes_written);
884#else
885 size_t bytes_written = 0;
886 unsigned char *ptr = (unsigned char *) buf;
887 struct timeout timeout;
888 fd_set fds;
889 int result;
890
891 timeout_start(&timeout, timeout_ms);
892
893 FD_ZERO(&fds);
894 FD_SET(port->fd, &fds);
895
896 /* Loop until we have written the requested number of bytes. */
897 while (bytes_written < count) {
898
899 if (timeout_check(&timeout))
900 break;
901
902 result = select(port->fd + 1, NULL, &fds, NULL, timeout_timeval(&timeout));
903
904 timeout_update(&timeout);
905
906 if (result < 0) {
907 if (errno == EINTR) {
908 DEBUG("select() call was interrupted, repeating");
909 continue;
910 } else {
911 RETURN_FAIL("select() failed");
912 }
913 } else if (result == 0) {
914 /* Timeout has expired. */
915 break;
916 }
917
918 /* Do write. */
919 result = write(port->fd, ptr, count - bytes_written);
920
921 if (result < 0) {
922 if (errno == EAGAIN)
923 /* This shouldn't happen because we did a select() first, but handle anyway. */
924 continue;
925 else
926 /* This is an actual failure. */
927 RETURN_FAIL("write() failed");
928 }
929
930 bytes_written += result;
931 ptr += result;
932 }
933
934 if (bytes_written < count)
935 DEBUG("Write timed out");
936
937 RETURN_INT(bytes_written);
938#endif
939}
940
941SP_API enum sp_return sp_nonblocking_write(struct sp_port *port,
942 const void *buf, size_t count)
943{
944 TRACE("%p, %p, %d", port, buf, count);
945
946 CHECK_OPEN_PORT();
947
948 if (!buf)
949 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
950
951 DEBUG_FMT("Writing up to %d bytes to port %s", count, port->name);
952
953 if (count == 0)
954 RETURN_INT(0);
955
956#ifdef _WIN32
957 size_t buf_bytes;
958
959 /* Check whether previous write is complete. */
960 if (port->writing) {
961 if (HasOverlappedIoCompleted(&port->write_ovl)) {
962 DEBUG("Previous write completed");
963 port->writing = 0;
964 } else {
965 DEBUG("Previous write not complete");
966 /* Can't take a new write until the previous one finishes. */
967 RETURN_INT(0);
968 }
969 }
970
971 /* Set timeout. */
972 if (port->timeouts.WriteTotalTimeoutConstant != 0) {
973 port->timeouts.WriteTotalTimeoutConstant = 0;
974 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
975 RETURN_FAIL("SetCommTimeouts() failed");
976 }
977
978 /* Reduce count if it exceeds the WriteFile limit. */
979 if (count > WRITEFILE_MAX_SIZE)
980 count = WRITEFILE_MAX_SIZE;
981
982 /* Copy data to our write buffer. */
983 buf_bytes = min(port->write_buf_size, count);
984 memcpy(port->write_buf, buf, buf_bytes);
985
986 /* Start asynchronous write. */
987 if (WriteFile(port->hdl, port->write_buf, (DWORD) buf_bytes, NULL, &port->write_ovl) == 0) {
988 if (GetLastError() == ERROR_IO_PENDING) {
989 if ((port->writing = !HasOverlappedIoCompleted(&port->write_ovl)))
990 DEBUG("Asynchronous write completed immediately");
991 else
992 DEBUG("Asynchronous write running");
993 } else {
994 /* Actual failure of some kind. */
995 RETURN_FAIL("WriteFile() failed");
996 }
997 }
998
999 DEBUG("All bytes written immediately");
1000
1001 RETURN_INT((int) buf_bytes);
1002#else
1003 /* Returns the number of bytes written, or -1 upon failure. */
1004 ssize_t written = write(port->fd, buf, count);
1005
1006 if (written < 0) {
1007 if (errno == EAGAIN)
1008 // Buffer is full, no bytes written.
1009 RETURN_INT(0);
1010 else
1011 RETURN_FAIL("write() failed");
1012 } else {
1013 RETURN_INT(written);
1014 }
1015#endif
1016}
1017
1018#ifdef _WIN32
1019/* Restart wait operation if buffer was emptied. */
1020static enum sp_return restart_wait_if_needed(struct sp_port *port, unsigned int bytes_read)
1021{
1022 DWORD errors;
1023 COMSTAT comstat;
1024
1025 if (bytes_read == 0)
1026 RETURN_OK();
1027
1028 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1029 RETURN_FAIL("ClearCommError() failed");
1030
1031 if (comstat.cbInQue == 0)
1032 TRY(restart_wait(port));
1033
1034 RETURN_OK();
1035}
1036#endif
1037
1038SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
1039 size_t count, unsigned int timeout_ms)
1040{
1041 TRACE("%p, %p, %d, %d", port, buf, count, timeout_ms);
1042
1043 CHECK_OPEN_PORT();
1044
1045 if (!buf)
1046 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
1047
1048 if (timeout_ms)
1049 DEBUG_FMT("Reading %d bytes from port %s, timeout %d ms",
1050 count, port->name, timeout_ms);
1051 else
1052 DEBUG_FMT("Reading %d bytes from port %s, no timeout",
1053 count, port->name);
1054
1055 if (count == 0)
1056 RETURN_INT(0);
1057
1058#ifdef _WIN32
1059 DWORD bytes_read;
1060
1061 /* Set timeout. */
1062 if (port->timeouts.ReadIntervalTimeout != 0 ||
1063 port->timeouts.ReadTotalTimeoutMultiplier != 0 ||
1064 port->timeouts.ReadTotalTimeoutConstant != timeout_ms) {
1065 port->timeouts.ReadIntervalTimeout = 0;
1066 port->timeouts.ReadTotalTimeoutMultiplier = 0;
1067 port->timeouts.ReadTotalTimeoutConstant = timeout_ms;
1068 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1069 RETURN_FAIL("SetCommTimeouts() failed");
1070 }
1071
1072 /* Start read. */
1073 if (ReadFile(port->hdl, buf, (DWORD) count, NULL, &port->read_ovl)) {
1074 DEBUG("Read completed immediately");
1075 bytes_read = (DWORD) count;
1076 } else if (GetLastError() == ERROR_IO_PENDING) {
1077 DEBUG("Waiting for read to complete");
1078 if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE) == 0)
1079 RETURN_FAIL("GetOverlappedResult() failed");
1080 DEBUG_FMT("Read completed, %d/%d bytes read", bytes_read, count);
1081 } else {
1082 RETURN_FAIL("ReadFile() failed");
1083 }
1084
1085 TRY(restart_wait_if_needed(port, bytes_read));
1086
1087 RETURN_INT((int) bytes_read);
1088
1089#else
1090 size_t bytes_read = 0;
1091 unsigned char *ptr = (unsigned char *) buf;
1092 struct timeout timeout;
1093 fd_set fds;
1094 int result;
1095
1096 timeout_start(&timeout, timeout_ms);
1097
1098 FD_ZERO(&fds);
1099 FD_SET(port->fd, &fds);
1100
1101 /* Loop until we have the requested number of bytes. */
1102 while (bytes_read < count) {
1103
1104 if (timeout_check(&timeout))
1105 /* Timeout has expired. */
1106 break;
1107
1108 result = select(port->fd + 1, &fds, NULL, NULL, timeout_timeval(&timeout));
1109
1110 timeout_update(&timeout);
1111
1112 if (result < 0) {
1113 if (errno == EINTR) {
1114 DEBUG("select() call was interrupted, repeating");
1115 continue;
1116 } else {
1117 RETURN_FAIL("select() failed");
1118 }
1119 } else if (result == 0) {
1120 /* Timeout has expired. */
1121 break;
1122 }
1123
1124 /* Do read. */
1125 result = read(port->fd, ptr, count - bytes_read);
1126
1127 if (result < 0) {
1128 if (errno == EAGAIN)
1129 /*
1130 * This shouldn't happen because we did a
1131 * select() first, but handle anyway.
1132 */
1133 continue;
1134 else
1135 /* This is an actual failure. */
1136 RETURN_FAIL("read() failed");
1137 }
1138
1139 bytes_read += result;
1140 ptr += result;
1141 }
1142
1143 if (bytes_read < count)
1144 DEBUG("Read timed out");
1145
1146 RETURN_INT(bytes_read);
1147#endif
1148}
1149
1150SP_API enum sp_return sp_blocking_read_next(struct sp_port *port, void *buf,
1151 size_t count, unsigned int timeout_ms)
1152{
1153 TRACE("%p, %p, %d, %d", port, buf, count, timeout_ms);
1154
1155 CHECK_OPEN_PORT();
1156
1157 if (!buf)
1158 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
1159
1160 if (count == 0)
1161 RETURN_ERROR(SP_ERR_ARG, "Zero count");
1162
1163 if (timeout_ms)
1164 DEBUG_FMT("Reading next max %d bytes from port %s, timeout %d ms",
1165 count, port->name, timeout_ms);
1166 else
1167 DEBUG_FMT("Reading next max %d bytes from port %s, no timeout",
1168 count, port->name);
1169
1170#ifdef _WIN32
1171 DWORD bytes_read = 0;
1172
1173 /* If timeout_ms == 0, set maximum timeout. */
1174 DWORD timeout_val = (timeout_ms == 0 ? MAXDWORD - 1 : timeout_ms);
1175
1176 /* Set timeout. */
1177 if (port->timeouts.ReadIntervalTimeout != MAXDWORD ||
1178 port->timeouts.ReadTotalTimeoutMultiplier != MAXDWORD ||
1179 port->timeouts.ReadTotalTimeoutConstant != timeout_val) {
1180 port->timeouts.ReadIntervalTimeout = MAXDWORD;
1181 port->timeouts.ReadTotalTimeoutMultiplier = MAXDWORD;
1182 port->timeouts.ReadTotalTimeoutConstant = timeout_val;
1183 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1184 RETURN_FAIL("SetCommTimeouts() failed");
1185 }
1186
1187 /* Loop until we have at least one byte, or timeout is reached. */
1188 while (bytes_read == 0) {
1189 /* Start read. */
1190 if (ReadFile(port->hdl, buf, (DWORD) count, &bytes_read, &port->read_ovl)) {
1191 DEBUG("Read completed immediately");
1192 } else if (GetLastError() == ERROR_IO_PENDING) {
1193 DEBUG("Waiting for read to complete");
1194 if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE) == 0)
1195 RETURN_FAIL("GetOverlappedResult() failed");
1196 if (bytes_read > 0) {
1197 DEBUG("Read completed");
1198 } else if (timeout_ms > 0) {
1199 DEBUG("Read timed out");
1200 break;
1201 } else {
1202 DEBUG("Restarting read");
1203 }
1204 } else {
1205 RETURN_FAIL("ReadFile() failed");
1206 }
1207 }
1208
1209 TRY(restart_wait_if_needed(port, bytes_read));
1210
1211 RETURN_INT(bytes_read);
1212
1213#else
1214 size_t bytes_read = 0;
1215 struct timeout timeout;
1216 fd_set fds;
1217 int result;
1218
1219 timeout_start(&timeout, timeout_ms);
1220
1221 FD_ZERO(&fds);
1222 FD_SET(port->fd, &fds);
1223
1224 /* Loop until we have at least one byte, or timeout is reached. */
1225 while (bytes_read == 0) {
1226
1227 if (timeout_check(&timeout))
1228 /* Timeout has expired. */
1229 break;
1230
1231 result = select(port->fd + 1, &fds, NULL, NULL, timeout_timeval(&timeout));
1232
1233 timeout_update(&timeout);
1234
1235 if (result < 0) {
1236 if (errno == EINTR) {
1237 DEBUG("select() call was interrupted, repeating");
1238 continue;
1239 } else {
1240 RETURN_FAIL("select() failed");
1241 }
1242 } else if (result == 0) {
1243 /* Timeout has expired. */
1244 break;
1245 }
1246
1247 /* Do read. */
1248 result = read(port->fd, buf, count);
1249
1250 if (result < 0) {
1251 if (errno == EAGAIN)
1252 /* This shouldn't happen because we did a select() first, but handle anyway. */
1253 continue;
1254 else
1255 /* This is an actual failure. */
1256 RETURN_FAIL("read() failed");
1257 }
1258
1259 bytes_read = result;
1260 }
1261
1262 if (bytes_read == 0)
1263 DEBUG("Read timed out");
1264
1265 RETURN_INT(bytes_read);
1266#endif
1267}
1268
1269SP_API enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf,
1270 size_t count)
1271{
1272 TRACE("%p, %p, %d", port, buf, count);
1273
1274 CHECK_OPEN_PORT();
1275
1276 if (!buf)
1277 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
1278
1279 DEBUG_FMT("Reading up to %d bytes from port %s", count, port->name);
1280
1281#ifdef _WIN32
1282 DWORD bytes_read;
1283
1284 /* Set timeout. */
1285 if (port->timeouts.ReadIntervalTimeout != MAXDWORD ||
1286 port->timeouts.ReadTotalTimeoutMultiplier != 0 ||
1287 port->timeouts.ReadTotalTimeoutConstant != 0) {
1288 port->timeouts.ReadIntervalTimeout = MAXDWORD;
1289 port->timeouts.ReadTotalTimeoutMultiplier = 0;
1290 port->timeouts.ReadTotalTimeoutConstant = 0;
1291 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1292 RETURN_FAIL("SetCommTimeouts() failed");
1293 }
1294
1295 /* Do read. */
1296 if (ReadFile(port->hdl, buf, (DWORD) count, NULL, &port->read_ovl) == 0)
1297 if (GetLastError() != ERROR_IO_PENDING)
1298 RETURN_FAIL("ReadFile() failed");
1299
1300 /* Get number of bytes read. */
1301 if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, FALSE) == 0)
1302 RETURN_FAIL("GetOverlappedResult() failed");
1303
1304 TRY(restart_wait_if_needed(port, bytes_read));
1305
1306 RETURN_INT(bytes_read);
1307#else
1308 ssize_t bytes_read;
1309
1310 /* Returns the number of bytes read, or -1 upon failure. */
1311 if ((bytes_read = read(port->fd, buf, count)) < 0) {
1312 if (errno == EAGAIN)
1313 /* No bytes available. */
1314 bytes_read = 0;
1315 else
1316 /* This is an actual failure. */
1317 RETURN_FAIL("read() failed");
1318 }
1319 RETURN_INT(bytes_read);
1320#endif
1321}
1322
1323SP_API enum sp_return sp_input_waiting(struct sp_port *port)
1324{
1325 TRACE("%p", port);
1326
1327 CHECK_OPEN_PORT();
1328
1329 DEBUG_FMT("Checking input bytes waiting on port %s", port->name);
1330
1331#ifdef _WIN32
1332 DWORD errors;
1333 COMSTAT comstat;
1334
1335 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1336 RETURN_FAIL("ClearCommError() failed");
1337 RETURN_INT(comstat.cbInQue);
1338#else
1339 int bytes_waiting;
1340 if (ioctl(port->fd, TIOCINQ, &bytes_waiting) < 0)
1341 RETURN_FAIL("TIOCINQ ioctl failed");
1342 RETURN_INT(bytes_waiting);
1343#endif
1344}
1345
1346SP_API enum sp_return sp_output_waiting(struct sp_port *port)
1347{
1348 TRACE("%p", port);
1349
1350#ifdef __CYGWIN__
1351 /* TIOCOUTQ is not defined in Cygwin headers */
1352 RETURN_ERROR(SP_ERR_SUPP,
1353 "Getting output bytes waiting is not supported on Cygwin");
1354#else
1355 CHECK_OPEN_PORT();
1356
1357 DEBUG_FMT("Checking output bytes waiting on port %s", port->name);
1358
1359#ifdef _WIN32
1360 DWORD errors;
1361 COMSTAT comstat;
1362
1363 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1364 RETURN_FAIL("ClearCommError() failed");
1365 RETURN_INT(comstat.cbOutQue);
1366#else
1367 int bytes_waiting;
1368 if (ioctl(port->fd, TIOCOUTQ, &bytes_waiting) < 0)
1369 RETURN_FAIL("TIOCOUTQ ioctl failed");
1370 RETURN_INT(bytes_waiting);
1371#endif
1372#endif
1373}
1374
1375SP_API enum sp_return sp_new_event_set(struct sp_event_set **result_ptr)
1376{
1377 struct sp_event_set *result;
1378
1379 TRACE("%p", result_ptr);
1380
1381 if (!result_ptr)
1382 RETURN_ERROR(SP_ERR_ARG, "Null result");
1383
1384 *result_ptr = NULL;
1385
1386 if (!(result = malloc(sizeof(struct sp_event_set))))
1387 RETURN_ERROR(SP_ERR_MEM, "sp_event_set malloc() failed");
1388
1389 memset(result, 0, sizeof(struct sp_event_set));
1390
1391 *result_ptr = result;
1392
1393 RETURN_OK();
1394}
1395
1396static enum sp_return add_handle(struct sp_event_set *event_set,
1397 event_handle handle, enum sp_event mask)
1398{
1399 void *new_handles;
1400 enum sp_event *new_masks;
1401
1402 TRACE("%p, %d, %d", event_set, handle, mask);
1403
1404 if (!(new_handles = realloc(event_set->handles,
1405 sizeof(event_handle) * (event_set->count + 1))))
1406 RETURN_ERROR(SP_ERR_MEM, "Handle array realloc() failed");
1407
1408 event_set->handles = new_handles;
1409
1410 if (!(new_masks = realloc(event_set->masks,
1411 sizeof(enum sp_event) * (event_set->count + 1))))
1412 RETURN_ERROR(SP_ERR_MEM, "Mask array realloc() failed");
1413
1414 event_set->masks = new_masks;
1415
1416 ((event_handle *) event_set->handles)[event_set->count] = handle;
1417 event_set->masks[event_set->count] = mask;
1418
1419 event_set->count++;
1420
1421 RETURN_OK();
1422}
1423
1424SP_API enum sp_return sp_add_port_events(struct sp_event_set *event_set,
1425 const struct sp_port *port, enum sp_event mask)
1426{
1427 TRACE("%p, %p, %d", event_set, port, mask);
1428
1429 if (!event_set)
1430 RETURN_ERROR(SP_ERR_ARG, "Null event set");
1431
1432 if (!port)
1433 RETURN_ERROR(SP_ERR_ARG, "Null port");
1434
1435 if (mask > (SP_EVENT_RX_READY | SP_EVENT_TX_READY | SP_EVENT_ERROR))
1436 RETURN_ERROR(SP_ERR_ARG, "Invalid event mask");
1437
1438 if (!mask)
1439 RETURN_OK();
1440
1441#ifdef _WIN32
1442 enum sp_event handle_mask;
1443 if ((handle_mask = mask & SP_EVENT_TX_READY))
1444 TRY(add_handle(event_set, port->write_ovl.hEvent, handle_mask));
1445 if ((handle_mask = mask & (SP_EVENT_RX_READY | SP_EVENT_ERROR)))
1446 TRY(add_handle(event_set, port->wait_ovl.hEvent, handle_mask));
1447#else
1448 TRY(add_handle(event_set, port->fd, mask));
1449#endif
1450
1451 RETURN_OK();
1452}
1453
1454SP_API void sp_free_event_set(struct sp_event_set *event_set)
1455{
1456 TRACE("%p", event_set);
1457
1458 if (!event_set) {
1459 DEBUG("Null event set");
1460 RETURN();
1461 }
1462
1463 DEBUG("Freeing event set");
1464
1465 if (event_set->handles)
1466 free(event_set->handles);
1467 if (event_set->masks)
1468 free(event_set->masks);
1469
1470 free(event_set);
1471
1472 RETURN();
1473}
1474
1475SP_API enum sp_return sp_wait(struct sp_event_set *event_set,
1476 unsigned int timeout_ms)
1477{
1478 TRACE("%p, %d", event_set, timeout_ms);
1479
1480 if (!event_set)
1481 RETURN_ERROR(SP_ERR_ARG, "Null event set");
1482
1483#ifdef _WIN32
1484 if (WaitForMultipleObjects(event_set->count, event_set->handles, FALSE,
1485 timeout_ms ? timeout_ms : INFINITE) == WAIT_FAILED)
1486 RETURN_FAIL("WaitForMultipleObjects() failed");
1487
1488 RETURN_OK();
1489#else
1490 struct timeout timeout;
1491 int poll_timeout;
1492 int result;
1493 struct pollfd *pollfds;
1494 unsigned int i;
1495
1496 if (!(pollfds = malloc(sizeof(struct pollfd) * event_set->count)))
1497 RETURN_ERROR(SP_ERR_MEM, "pollfds malloc() failed");
1498
1499 for (i = 0; i < event_set->count; i++) {
1500 pollfds[i].fd = ((int *)event_set->handles)[i];
1501 pollfds[i].events = 0;
1502 pollfds[i].revents = 0;
1503 if (event_set->masks[i] & SP_EVENT_RX_READY)
1504 pollfds[i].events |= POLLIN;
1505 if (event_set->masks[i] & SP_EVENT_TX_READY)
1506 pollfds[i].events |= POLLOUT;
1507 if (event_set->masks[i] & SP_EVENT_ERROR)
1508 pollfds[i].events |= POLLERR;
1509 }
1510
1511 timeout_start(&timeout, timeout_ms);
1512 timeout_limit(&timeout, INT_MAX);
1513
1514 /* Loop until an event occurs. */
1515 while (1) {
1516
1517 if (timeout_check(&timeout)) {
1518 DEBUG("Wait timed out");
1519 break;
1520 }
1521
1522 poll_timeout = (int) timeout_remaining_ms(&timeout);
1523 if (poll_timeout == 0)
1524 poll_timeout = -1;
1525
1526 result = poll(pollfds, event_set->count, poll_timeout);
1527
1528 timeout_update(&timeout);
1529
1530 if (result < 0) {
1531 if (errno == EINTR) {
1532 DEBUG("poll() call was interrupted, repeating");
1533 continue;
1534 } else {
1535 free(pollfds);
1536 RETURN_FAIL("poll() failed");
1537 }
1538 } else if (result == 0) {
1539 DEBUG("poll() timed out");
1540 if (!timeout.overflow)
1541 break;
1542 } else {
1543 DEBUG("poll() completed");
1544 break;
1545 }
1546 }
1547
1548 free(pollfds);
1549 RETURN_OK();
1550#endif
1551}
1552
1553#ifdef USE_TERMIOS_SPEED
1554static enum sp_return get_baudrate(int fd, int *baudrate)
1555{
1556 void *data;
1557
1558 TRACE("%d, %p", fd, baudrate);
1559
1560 DEBUG("Getting baud rate");
1561
1562 if (!(data = malloc(get_termios_size())))
1563 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1564
1565 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1566 free(data);
1567 RETURN_FAIL("Getting termios failed");
1568 }
1569
1570 *baudrate = get_termios_speed(data);
1571
1572 free(data);
1573
1574 RETURN_OK();
1575}
1576
1577static enum sp_return set_baudrate(int fd, int baudrate)
1578{
1579 void *data;
1580
1581 TRACE("%d, %d", fd, baudrate);
1582
1583 DEBUG("Getting baud rate");
1584
1585 if (!(data = malloc(get_termios_size())))
1586 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1587
1588 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1589 free(data);
1590 RETURN_FAIL("Getting termios failed");
1591 }
1592
1593 DEBUG("Setting baud rate");
1594
1595 set_termios_speed(data, baudrate);
1596
1597 if (ioctl(fd, get_termios_set_ioctl(), data) < 0) {
1598 free(data);
1599 RETURN_FAIL("Setting termios failed");
1600 }
1601
1602 free(data);
1603
1604 RETURN_OK();
1605}
1606#endif /* USE_TERMIOS_SPEED */
1607
1608#ifdef USE_TERMIOX
1609static enum sp_return get_flow(int fd, struct port_data *data)
1610{
1611 void *termx;
1612
1613 TRACE("%d, %p", fd, data);
1614
1615 DEBUG("Getting advanced flow control");
1616
1617 if (!(termx = malloc(get_termiox_size())))
1618 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1619
1620 if (ioctl(fd, TCGETX, termx) < 0) {
1621 free(termx);
1622 RETURN_FAIL("Getting termiox failed");
1623 }
1624
1625 get_termiox_flow(termx, &data->rts_flow, &data->cts_flow,
1626 &data->dtr_flow, &data->dsr_flow);
1627
1628 free(termx);
1629
1630 RETURN_OK();
1631}
1632
1633static enum sp_return set_flow(int fd, struct port_data *data)
1634{
1635 void *termx;
1636
1637 TRACE("%d, %p", fd, data);
1638
1639 DEBUG("Getting advanced flow control");
1640
1641 if (!(termx = malloc(get_termiox_size())))
1642 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1643
1644 if (ioctl(fd, TCGETX, termx) < 0) {
1645 free(termx);
1646 RETURN_FAIL("Getting termiox failed");
1647 }
1648
1649 DEBUG("Setting advanced flow control");
1650
1651 set_termiox_flow(termx, data->rts_flow, data->cts_flow,
1652 data->dtr_flow, data->dsr_flow);
1653
1654 if (ioctl(fd, TCSETX, termx) < 0) {
1655 free(termx);
1656 RETURN_FAIL("Setting termiox failed");
1657 }
1658
1659 free(termx);
1660
1661 RETURN_OK();
1662}
1663#endif /* USE_TERMIOX */
1664
1665static enum sp_return get_config(struct sp_port *port, struct port_data *data,
1666 struct sp_port_config *config)
1667{
1668 unsigned int i;
1669
1670 TRACE("%p, %p, %p", port, data, config);
1671
1672 DEBUG_FMT("Getting configuration for port %s", port->name);
1673
1674#ifdef _WIN32
1675 if (!GetCommState(port->hdl, &data->dcb))
1676 RETURN_FAIL("GetCommState() failed");
1677
1678 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1679 if (data->dcb.BaudRate == std_baudrates[i].index) {
1680 config->baudrate = std_baudrates[i].value;
1681 break;
1682 }
1683 }
1684
1685 if (i == NUM_STD_BAUDRATES)
1686 /* BaudRate field can be either an index or a custom baud rate. */
1687 config->baudrate = data->dcb.BaudRate;
1688
1689 config->bits = data->dcb.ByteSize;
1690
1691 switch (data->dcb.Parity) {
1692 case NOPARITY:
1693 config->parity = SP_PARITY_NONE;
1694 break;
1695 case ODDPARITY:
1696 config->parity = SP_PARITY_ODD;
1697 break;
1698 case EVENPARITY:
1699 config->parity = SP_PARITY_EVEN;
1700 break;
1701 case MARKPARITY:
1702 config->parity = SP_PARITY_MARK;
1703 break;
1704 case SPACEPARITY:
1705 config->parity = SP_PARITY_SPACE;
1706 break;
1707 default:
1708 config->parity = -1;
1709 }
1710
1711 switch (data->dcb.StopBits) {
1712 case ONESTOPBIT:
1713 config->stopbits = 1;
1714 break;
1715 case TWOSTOPBITS:
1716 config->stopbits = 2;
1717 break;
1718 default:
1719 config->stopbits = -1;
1720 }
1721
1722 switch (data->dcb.fRtsControl) {
1723 case RTS_CONTROL_DISABLE:
1724 config->rts = SP_RTS_OFF;
1725 break;
1726 case RTS_CONTROL_ENABLE:
1727 config->rts = SP_RTS_ON;
1728 break;
1729 case RTS_CONTROL_HANDSHAKE:
1730 config->rts = SP_RTS_FLOW_CONTROL;
1731 break;
1732 default:
1733 config->rts = -1;
1734 }
1735
1736 config->cts = data->dcb.fOutxCtsFlow ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1737
1738 switch (data->dcb.fDtrControl) {
1739 case DTR_CONTROL_DISABLE:
1740 config->dtr = SP_DTR_OFF;
1741 break;
1742 case DTR_CONTROL_ENABLE:
1743 config->dtr = SP_DTR_ON;
1744 break;
1745 case DTR_CONTROL_HANDSHAKE:
1746 config->dtr = SP_DTR_FLOW_CONTROL;
1747 break;
1748 default:
1749 config->dtr = -1;
1750 }
1751
1752 config->dsr = data->dcb.fOutxDsrFlow ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1753
1754 if (data->dcb.fInX) {
1755 if (data->dcb.fOutX)
1756 config->xon_xoff = SP_XONXOFF_INOUT;
1757 else
1758 config->xon_xoff = SP_XONXOFF_IN;
1759 } else {
1760 if (data->dcb.fOutX)
1761 config->xon_xoff = SP_XONXOFF_OUT;
1762 else
1763 config->xon_xoff = SP_XONXOFF_DISABLED;
1764 }
1765
1766#else // !_WIN32
1767
1768 if (tcgetattr(port->fd, &data->term) < 0)
1769 RETURN_FAIL("tcgetattr() failed");
1770
1771 if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0)
1772 RETURN_FAIL("TIOCMGET ioctl failed");
1773
1774#ifdef USE_TERMIOX
1775 int ret = get_flow(port->fd, data);
1776
1777 if (ret == SP_ERR_FAIL && errno == EINVAL)
1778 data->termiox_supported = 0;
1779 else if (ret < 0)
1780 RETURN_CODEVAL(ret);
1781 else
1782 data->termiox_supported = 1;
1783#else
1784 data->termiox_supported = 0;
1785#endif
1786
1787 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1788 if (cfgetispeed(&data->term) == std_baudrates[i].index) {
1789 config->baudrate = std_baudrates[i].value;
1790 break;
1791 }
1792 }
1793
1794 if (i == NUM_STD_BAUDRATES) {
1795#ifdef __APPLE__
1796 config->baudrate = (int)data->term.c_ispeed;
1797#elif defined(USE_TERMIOS_SPEED)
1798 TRY(get_baudrate(port->fd, &config->baudrate));
1799#else
1800 config->baudrate = -1;
1801#endif
1802 }
1803
1804 switch (data->term.c_cflag & CSIZE) {
1805 case CS8:
1806 config->bits = 8;
1807 break;
1808 case CS7:
1809 config->bits = 7;
1810 break;
1811 case CS6:
1812 config->bits = 6;
1813 break;
1814 case CS5:
1815 config->bits = 5;
1816 break;
1817 default:
1818 config->bits = -1;
1819 }
1820
1821 if (!(data->term.c_cflag & PARENB) && (data->term.c_iflag & IGNPAR))
1822 config->parity = SP_PARITY_NONE;
1823 else if (!(data->term.c_cflag & PARENB) || (data->term.c_iflag & IGNPAR))
1824 config->parity = -1;
1825#ifdef CMSPAR
1826 else if (data->term.c_cflag & CMSPAR)
1827 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_MARK : SP_PARITY_SPACE;
1828#endif
1829 else
1830 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_ODD : SP_PARITY_EVEN;
1831
1832 config->stopbits = (data->term.c_cflag & CSTOPB) ? 2 : 1;
1833
1834 if (data->term.c_cflag & CRTSCTS) {
1835 config->rts = SP_RTS_FLOW_CONTROL;
1836 config->cts = SP_CTS_FLOW_CONTROL;
1837 } else {
1838 if (data->termiox_supported && data->rts_flow)
1839 config->rts = SP_RTS_FLOW_CONTROL;
1840 else
1841 config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
1842
1843 config->cts = (data->termiox_supported && data->cts_flow) ?
1844 SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1845 }
1846
1847 if (data->termiox_supported && data->dtr_flow)
1848 config->dtr = SP_DTR_FLOW_CONTROL;
1849 else
1850 config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
1851
1852 config->dsr = (data->termiox_supported && data->dsr_flow) ?
1853 SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1854
1855 if (data->term.c_iflag & IXOFF) {
1856 if (data->term.c_iflag & IXON)
1857 config->xon_xoff = SP_XONXOFF_INOUT;
1858 else
1859 config->xon_xoff = SP_XONXOFF_IN;
1860 } else {
1861 if (data->term.c_iflag & IXON)
1862 config->xon_xoff = SP_XONXOFF_OUT;
1863 else
1864 config->xon_xoff = SP_XONXOFF_DISABLED;
1865 }
1866#endif
1867
1868 RETURN_OK();
1869}
1870
1871static enum sp_return set_config(struct sp_port *port, struct port_data *data,
1872 const struct sp_port_config *config)
1873{
1874 unsigned int i;
1875#ifdef __APPLE__
1876 BAUD_TYPE baud_nonstd;
1877
1878 baud_nonstd = B0;
1879#endif
1880#ifdef USE_TERMIOS_SPEED
1881 int baud_nonstd = 0;
1882#endif
1883
1884 TRACE("%p, %p, %p", port, data, config);
1885
1886 DEBUG_FMT("Setting configuration for port %s", port->name);
1887
1888#ifdef _WIN32
1889 BYTE* new_buf;
1890
1891 TRY(await_write_completion(port));
1892
1893 if (config->baudrate >= 0) {
1894 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1895 if (config->baudrate == std_baudrates[i].value) {
1896 data->dcb.BaudRate = std_baudrates[i].index;
1897 break;
1898 }
1899 }
1900
1901 if (i == NUM_STD_BAUDRATES)
1902 data->dcb.BaudRate = config->baudrate;
1903
1904 /* Allocate write buffer for 50ms of data at baud rate. */
1905 port->write_buf_size = max(config->baudrate / (8 * 20), 1);
1906 new_buf = realloc(port->write_buf, port->write_buf_size);
1907 if (!new_buf)
1908 RETURN_ERROR(SP_ERR_MEM, "Allocating write buffer failed");
1909 port->write_buf = new_buf;
1910 }
1911
1912 if (config->bits >= 0)
1913 data->dcb.ByteSize = config->bits;
1914
1915 if (config->parity >= 0) {
1916 switch (config->parity) {
1917 case SP_PARITY_NONE:
1918 data->dcb.Parity = NOPARITY;
1919 break;
1920 case SP_PARITY_ODD:
1921 data->dcb.Parity = ODDPARITY;
1922 break;
1923 case SP_PARITY_EVEN:
1924 data->dcb.Parity = EVENPARITY;
1925 break;
1926 case SP_PARITY_MARK:
1927 data->dcb.Parity = MARKPARITY;
1928 break;
1929 case SP_PARITY_SPACE:
1930 data->dcb.Parity = SPACEPARITY;
1931 break;
1932 default:
1933 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1934 }
1935 }
1936
1937 if (config->stopbits >= 0) {
1938 switch (config->stopbits) {
1939 /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
1940 case 1:
1941 data->dcb.StopBits = ONESTOPBIT;
1942 break;
1943 case 2:
1944 data->dcb.StopBits = TWOSTOPBITS;
1945 break;
1946 default:
1947 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bit setting");
1948 }
1949 }
1950
1951 if (config->rts >= 0) {
1952 switch (config->rts) {
1953 case SP_RTS_OFF:
1954 data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
1955 break;
1956 case SP_RTS_ON:
1957 data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
1958 break;
1959 case SP_RTS_FLOW_CONTROL:
1960 data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
1961 break;
1962 default:
1963 RETURN_ERROR(SP_ERR_ARG, "Invalid RTS setting");
1964 }
1965 }
1966
1967 if (config->cts >= 0) {
1968 switch (config->cts) {
1969 case SP_CTS_IGNORE:
1970 data->dcb.fOutxCtsFlow = FALSE;
1971 break;
1972 case SP_CTS_FLOW_CONTROL:
1973 data->dcb.fOutxCtsFlow = TRUE;
1974 break;
1975 default:
1976 RETURN_ERROR(SP_ERR_ARG, "Invalid CTS setting");
1977 }
1978 }
1979
1980 if (config->dtr >= 0) {
1981 switch (config->dtr) {
1982 case SP_DTR_OFF:
1983 data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
1984 break;
1985 case SP_DTR_ON:
1986 data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
1987 break;
1988 case SP_DTR_FLOW_CONTROL:
1989 data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
1990 break;
1991 default:
1992 RETURN_ERROR(SP_ERR_ARG, "Invalid DTR setting");
1993 }
1994 }
1995
1996 if (config->dsr >= 0) {
1997 switch (config->dsr) {
1998 case SP_DSR_IGNORE:
1999 data->dcb.fOutxDsrFlow = FALSE;
2000 break;
2001 case SP_DSR_FLOW_CONTROL:
2002 data->dcb.fOutxDsrFlow = TRUE;
2003 break;
2004 default:
2005 RETURN_ERROR(SP_ERR_ARG, "Invalid DSR setting");
2006 }
2007 }
2008
2009 if (config->xon_xoff >= 0) {
2010 switch (config->xon_xoff) {
2011 case SP_XONXOFF_DISABLED:
2012 data->dcb.fInX = FALSE;
2013 data->dcb.fOutX = FALSE;
2014 break;
2015 case SP_XONXOFF_IN:
2016 data->dcb.fInX = TRUE;
2017 data->dcb.fOutX = FALSE;
2018 break;
2019 case SP_XONXOFF_OUT:
2020 data->dcb.fInX = FALSE;
2021 data->dcb.fOutX = TRUE;
2022 break;
2023 case SP_XONXOFF_INOUT:
2024 data->dcb.fInX = TRUE;
2025 data->dcb.fOutX = TRUE;
2026 break;
2027 default:
2028 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
2029 }
2030 }
2031
2032 if (!SetCommState(port->hdl, &data->dcb))
2033 RETURN_FAIL("SetCommState() failed");
2034
2035#else /* !_WIN32 */
2036
2037 int controlbits;
2038
2039 if (config->baudrate >= 0) {
2040 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
2041 if (config->baudrate == std_baudrates[i].value) {
2042 if (cfsetospeed(&data->term, std_baudrates[i].index) < 0)
2043 RETURN_FAIL("cfsetospeed() failed");
2044
2045 if (cfsetispeed(&data->term, std_baudrates[i].index) < 0)
2046 RETURN_FAIL("cfsetispeed() failed");
2047 break;
2048 }
2049 }
2050
2051 /* Non-standard baud rate */
2052 if (i == NUM_STD_BAUDRATES) {
2053#ifdef __APPLE__
2054 /* Set "dummy" baud rate. */
2055 if (cfsetspeed(&data->term, B9600) < 0)
2056 RETURN_FAIL("cfsetspeed() failed");
2057 baud_nonstd = config->baudrate;
2058#elif defined(USE_TERMIOS_SPEED)
2059 baud_nonstd = 1;
2060#else
2061 RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported");
2062#endif
2063 }
2064 }
2065
2066 if (config->bits >= 0) {
2067 data->term.c_cflag &= ~CSIZE;
2068 switch (config->bits) {
2069 case 8:
2070 data->term.c_cflag |= CS8;
2071 break;
2072 case 7:
2073 data->term.c_cflag |= CS7;
2074 break;
2075 case 6:
2076 data->term.c_cflag |= CS6;
2077 break;
2078 case 5:
2079 data->term.c_cflag |= CS5;
2080 break;
2081 default:
2082 RETURN_ERROR(SP_ERR_ARG, "Invalid data bits setting");
2083 }
2084 }
2085
2086 if (config->parity >= 0) {
2087 data->term.c_iflag &= ~IGNPAR;
2088 data->term.c_cflag &= ~(PARENB | PARODD);
2089#ifdef CMSPAR
2090 data->term.c_cflag &= ~CMSPAR;
2091#endif
2092 switch (config->parity) {
2093 case SP_PARITY_NONE:
2094 data->term.c_iflag |= IGNPAR;
2095 break;
2096 case SP_PARITY_EVEN:
2097 data->term.c_cflag |= PARENB;
2098 break;
2099 case SP_PARITY_ODD:
2100 data->term.c_cflag |= PARENB | PARODD;
2101 break;
2102#ifdef CMSPAR
2103 case SP_PARITY_MARK:
2104 data->term.c_cflag |= PARENB | PARODD;
2105 data->term.c_cflag |= CMSPAR;
2106 break;
2107 case SP_PARITY_SPACE:
2108 data->term.c_cflag |= PARENB;
2109 data->term.c_cflag |= CMSPAR;
2110 break;
2111#else
2112 case SP_PARITY_MARK:
2113 case SP_PARITY_SPACE:
2114 RETURN_ERROR(SP_ERR_SUPP, "Mark/space parity not supported");
2115#endif
2116 default:
2117 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
2118 }
2119 }
2120
2121 if (config->stopbits >= 0) {
2122 data->term.c_cflag &= ~CSTOPB;
2123 switch (config->stopbits) {
2124 case 1:
2125 data->term.c_cflag &= ~CSTOPB;
2126 break;
2127 case 2:
2128 data->term.c_cflag |= CSTOPB;
2129 break;
2130 default:
2131 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bits setting");
2132 }
2133 }
2134
2135 if (config->rts >= 0 || config->cts >= 0) {
2136 if (data->termiox_supported) {
2137 data->rts_flow = data->cts_flow = 0;
2138 switch (config->rts) {
2139 case SP_RTS_OFF:
2140 case SP_RTS_ON:
2141 controlbits = TIOCM_RTS;
2142 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
2143 RETURN_FAIL("Setting RTS signal level failed");
2144 break;
2145 case SP_RTS_FLOW_CONTROL:
2146 data->rts_flow = 1;
2147 break;
2148 default:
2149 break;
2150 }
2151 if (config->cts == SP_CTS_FLOW_CONTROL)
2152 data->cts_flow = 1;
2153
2154 if (data->rts_flow && data->cts_flow)
2155 data->term.c_iflag |= CRTSCTS;
2156 else
2157 data->term.c_iflag &= ~CRTSCTS;
2158 } else {
2159 /* Asymmetric use of RTS/CTS not supported. */
2160 if (data->term.c_iflag & CRTSCTS) {
2161 /* Flow control can only be disabled for both RTS & CTS together. */
2162 if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) {
2163 if (config->cts != SP_CTS_IGNORE)
2164 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
2165 }
2166 if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) {
2167 if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL)
2168 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
2169 }
2170 } else {
2171 /* Flow control can only be enabled for both RTS & CTS together. */
2172 if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) ||
2173 ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL)))
2174 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be enabled together");
2175 }
2176
2177 if (config->rts >= 0) {
2178 if (config->rts == SP_RTS_FLOW_CONTROL) {
2179 data->term.c_iflag |= CRTSCTS;
2180 } else {
2181 controlbits = TIOCM_RTS;
2182 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
2183 &controlbits) < 0)
2184 RETURN_FAIL("Setting RTS signal level failed");
2185 }
2186 }
2187 }
2188 }
2189
2190 if (config->dtr >= 0 || config->dsr >= 0) {
2191 if (data->termiox_supported) {
2192 data->dtr_flow = data->dsr_flow = 0;
2193 switch (config->dtr) {
2194 case SP_DTR_OFF:
2195 case SP_DTR_ON:
2196 controlbits = TIOCM_DTR;
2197 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
2198 RETURN_FAIL("Setting DTR signal level failed");
2199 break;
2200 case SP_DTR_FLOW_CONTROL:
2201 data->dtr_flow = 1;
2202 break;
2203 default:
2204 break;
2205 }
2206 if (config->dsr == SP_DSR_FLOW_CONTROL)
2207 data->dsr_flow = 1;
2208 } else {
2209 /* DTR/DSR flow control not supported. */
2210 if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
2211 RETURN_ERROR(SP_ERR_SUPP, "DTR/DSR flow control not supported");
2212
2213 if (config->dtr >= 0) {
2214 controlbits = TIOCM_DTR;
2215 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
2216 &controlbits) < 0)
2217 RETURN_FAIL("Setting DTR signal level failed");
2218 }
2219 }
2220 }
2221
2222 if (config->xon_xoff >= 0) {
2223 data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
2224 switch (config->xon_xoff) {
2225 case SP_XONXOFF_DISABLED:
2226 break;
2227 case SP_XONXOFF_IN:
2228 data->term.c_iflag |= IXOFF;
2229 break;
2230 case SP_XONXOFF_OUT:
2231 data->term.c_iflag |= IXON | IXANY;
2232 break;
2233 case SP_XONXOFF_INOUT:
2234 data->term.c_iflag |= IXON | IXOFF | IXANY;
2235 break;
2236 default:
2237 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
2238 }
2239 }
2240
2241 if (tcsetattr(port->fd, TCSANOW, &data->term) < 0)
2242 RETURN_FAIL("tcsetattr() failed");
2243
2244#ifdef __APPLE__
2245 if (baud_nonstd != B0) {
2246 if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1)
2247 RETURN_FAIL("IOSSIOSPEED ioctl failed");
2248 /*
2249 * Set baud rates in data->term to correct, but incompatible
2250 * with tcsetattr() value, same as delivered by tcgetattr().
2251 */
2252 if (cfsetspeed(&data->term, baud_nonstd) < 0)
2253 RETURN_FAIL("cfsetspeed() failed");
2254 }
2255#elif defined(__linux__)
2256#ifdef USE_TERMIOS_SPEED
2257 if (baud_nonstd)
2258 TRY(set_baudrate(port->fd, config->baudrate));
2259#endif
2260#ifdef USE_TERMIOX
2261 if (data->termiox_supported)
2262 TRY(set_flow(port->fd, data));
2263#endif
2264#endif
2265
2266#endif /* !_WIN32 */
2267
2268 RETURN_OK();
2269}
2270
2271SP_API enum sp_return sp_new_config(struct sp_port_config **config_ptr)
2272{
2273 struct sp_port_config *config;
2274
2275 TRACE("%p", config_ptr);
2276
2277 if (!config_ptr)
2278 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2279
2280 *config_ptr = NULL;
2281
2282 if (!(config = malloc(sizeof(struct sp_port_config))))
2283 RETURN_ERROR(SP_ERR_MEM, "Config malloc failed");
2284
2285 config->baudrate = -1;
2286 config->bits = -1;
2287 config->parity = -1;
2288 config->stopbits = -1;
2289 config->rts = -1;
2290 config->cts = -1;
2291 config->dtr = -1;
2292 config->dsr = -1;
2293
2294 *config_ptr = config;
2295
2296 RETURN_OK();
2297}
2298
2299SP_API void sp_free_config(struct sp_port_config *config)
2300{
2301 TRACE("%p", config);
2302
2303 if (!config)
2304 DEBUG("Null config");
2305 else
2306 free(config);
2307
2308 RETURN();
2309}
2310
2311SP_API enum sp_return sp_get_config(struct sp_port *port,
2312 struct sp_port_config *config)
2313{
2314 struct port_data data;
2315
2316 TRACE("%p, %p", port, config);
2317
2318 CHECK_OPEN_PORT();
2319
2320 if (!config)
2321 RETURN_ERROR(SP_ERR_ARG, "Null config");
2322
2323 TRY(get_config(port, &data, config));
2324
2325 RETURN_OK();
2326}
2327
2328SP_API enum sp_return sp_set_config(struct sp_port *port,
2329 const struct sp_port_config *config)
2330{
2331 struct port_data data;
2332 struct sp_port_config prev_config;
2333
2334 TRACE("%p, %p", port, config);
2335
2336 CHECK_OPEN_PORT();
2337
2338 if (!config)
2339 RETURN_ERROR(SP_ERR_ARG, "Null config");
2340
2341 TRY(get_config(port, &data, &prev_config));
2342 TRY(set_config(port, &data, config));
2343
2344 RETURN_OK();
2345}
2346
2347#define CREATE_ACCESSORS(x, type) \
2348SP_API enum sp_return sp_set_##x(struct sp_port *port, type x) { \
2349 struct port_data data; \
2350 struct sp_port_config config; \
2351 TRACE("%p, %d", port, x); \
2352 CHECK_OPEN_PORT(); \
2353 TRY(get_config(port, &data, &config)); \
2354 config.x = x; \
2355 TRY(set_config(port, &data, &config)); \
2356 RETURN_OK(); \
2357} \
2358SP_API enum sp_return sp_get_config_##x(const struct sp_port_config *config, \
2359 type *x) { \
2360 TRACE("%p, %p", config, x); \
2361 if (!x) \
2362 RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); \
2363 if (!config) \
2364 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2365 *x = config->x; \
2366 RETURN_OK(); \
2367} \
2368SP_API enum sp_return sp_set_config_##x(struct sp_port_config *config, \
2369 type x) { \
2370 TRACE("%p, %d", config, x); \
2371 if (!config) \
2372 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2373 config->x = x; \
2374 RETURN_OK(); \
2375}
2376
2377CREATE_ACCESSORS(baudrate, int)
2378CREATE_ACCESSORS(bits, int)
2379CREATE_ACCESSORS(parity, enum sp_parity)
2380CREATE_ACCESSORS(stopbits, int)
2381CREATE_ACCESSORS(rts, enum sp_rts)
2382CREATE_ACCESSORS(cts, enum sp_cts)
2383CREATE_ACCESSORS(dtr, enum sp_dtr)
2384CREATE_ACCESSORS(dsr, enum sp_dsr)
2385CREATE_ACCESSORS(xon_xoff, enum sp_xonxoff)
2386
2387SP_API enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config,
2388 enum sp_flowcontrol flowcontrol)
2389{
2390 if (!config)
2391 RETURN_ERROR(SP_ERR_ARG, "Null configuration");
2392
2393 if (flowcontrol > SP_FLOWCONTROL_DTRDSR)
2394 RETURN_ERROR(SP_ERR_ARG, "Invalid flow control setting");
2395
2396 if (flowcontrol == SP_FLOWCONTROL_XONXOFF)
2397 config->xon_xoff = SP_XONXOFF_INOUT;
2398 else
2399 config->xon_xoff = SP_XONXOFF_DISABLED;
2400
2401 if (flowcontrol == SP_FLOWCONTROL_RTSCTS) {
2402 config->rts = SP_RTS_FLOW_CONTROL;
2403 config->cts = SP_CTS_FLOW_CONTROL;
2404 } else {
2405 if (config->rts == SP_RTS_FLOW_CONTROL)
2406 config->rts = SP_RTS_ON;
2407 config->cts = SP_CTS_IGNORE;
2408 }
2409
2410 if (flowcontrol == SP_FLOWCONTROL_DTRDSR) {
2411 config->dtr = SP_DTR_FLOW_CONTROL;
2412 config->dsr = SP_DSR_FLOW_CONTROL;
2413 } else {
2414 if (config->dtr == SP_DTR_FLOW_CONTROL)
2415 config->dtr = SP_DTR_ON;
2416 config->dsr = SP_DSR_IGNORE;
2417 }
2418
2419 RETURN_OK();
2420}
2421
2422SP_API enum sp_return sp_set_flowcontrol(struct sp_port *port,
2423 enum sp_flowcontrol flowcontrol)
2424{
2425 struct port_data data;
2426 struct sp_port_config config;
2427
2428 TRACE("%p, %d", port, flowcontrol);
2429
2430 CHECK_OPEN_PORT();
2431
2432 TRY(get_config(port, &data, &config));
2433
2434 TRY(sp_set_config_flowcontrol(&config, flowcontrol));
2435
2436 TRY(set_config(port, &data, &config));
2437
2438 RETURN_OK();
2439}
2440
2441SP_API enum sp_return sp_get_signals(struct sp_port *port,
2442 enum sp_signal *signals)
2443{
2444 TRACE("%p, %p", port, signals);
2445
2446 CHECK_OPEN_PORT();
2447
2448 if (!signals)
2449 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2450
2451 DEBUG_FMT("Getting control signals for port %s", port->name);
2452
2453 *signals = 0;
2454#ifdef _WIN32
2455 DWORD bits;
2456 if (GetCommModemStatus(port->hdl, &bits) == 0)
2457 RETURN_FAIL("GetCommModemStatus() failed");
2458 if (bits & MS_CTS_ON)
2459 *signals |= SP_SIG_CTS;
2460 if (bits & MS_DSR_ON)
2461 *signals |= SP_SIG_DSR;
2462 if (bits & MS_RLSD_ON)
2463 *signals |= SP_SIG_DCD;
2464 if (bits & MS_RING_ON)
2465 *signals |= SP_SIG_RI;
2466#else
2467 int bits;
2468 if (ioctl(port->fd, TIOCMGET, &bits) < 0)
2469 RETURN_FAIL("TIOCMGET ioctl failed");
2470 if (bits & TIOCM_CTS)
2471 *signals |= SP_SIG_CTS;
2472 if (bits & TIOCM_DSR)
2473 *signals |= SP_SIG_DSR;
2474 if (bits & TIOCM_CAR)
2475 *signals |= SP_SIG_DCD;
2476 if (bits & TIOCM_RNG)
2477 *signals |= SP_SIG_RI;
2478#endif
2479 RETURN_OK();
2480}
2481
2482SP_API enum sp_return sp_start_break(struct sp_port *port)
2483{
2484 TRACE("%p", port);
2485
2486 CHECK_OPEN_PORT();
2487#ifdef _WIN32
2488 if (SetCommBreak(port->hdl) == 0)
2489 RETURN_FAIL("SetCommBreak() failed");
2490#else
2491 if (ioctl(port->fd, TIOCSBRK, 1) < 0)
2492 RETURN_FAIL("TIOCSBRK ioctl failed");
2493#endif
2494
2495 RETURN_OK();
2496}
2497
2498SP_API enum sp_return sp_end_break(struct sp_port *port)
2499{
2500 TRACE("%p", port);
2501
2502 CHECK_OPEN_PORT();
2503#ifdef _WIN32
2504 if (ClearCommBreak(port->hdl) == 0)
2505 RETURN_FAIL("ClearCommBreak() failed");
2506#else
2507 if (ioctl(port->fd, TIOCCBRK, 1) < 0)
2508 RETURN_FAIL("TIOCCBRK ioctl failed");
2509#endif
2510
2511 RETURN_OK();
2512}
2513
2514SP_API int sp_last_error_code(void)
2515{
2516 TRACE_VOID();
2517#ifdef _WIN32
2518 RETURN_INT(GetLastError());
2519#else
2520 RETURN_INT(errno);
2521#endif
2522}
2523
2524SP_API char *sp_last_error_message(void)
2525{
2526 TRACE_VOID();
2527
2528#ifdef _WIN32
2529 char *message;
2530 DWORD error = GetLastError();
2531
2532 DWORD length = FormatMessageA(
2533 FORMAT_MESSAGE_ALLOCATE_BUFFER |
2534 FORMAT_MESSAGE_FROM_SYSTEM |
2535 FORMAT_MESSAGE_IGNORE_INSERTS,
2536 NULL,
2537 error,
2538 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
2539 (LPSTR) &message,
2540 0, NULL );
2541
2542 if (length >= 2 && message[length - 2] == '\r')
2543 message[length - 2] = '\0';
2544
2545 RETURN_STRING(message);
2546#else
2547 RETURN_STRING(strerror(errno));
2548#endif
2549}
2550
2551SP_API void sp_free_error_message(char *message)
2552{
2553 TRACE("%s", message);
2554
2555#ifdef _WIN32
2556 LocalFree(message);
2557#else
2558 (void)message;
2559#endif
2560
2561 RETURN();
2562}
2563
2564SP_API void sp_set_debug_handler(void (*handler)(const char *format, ...))
2565{
2566 TRACE("%p", handler);
2567
2568 sp_debug_handler = handler;
2569
2570 RETURN();
2571}
2572
2573SP_API void sp_default_debug_handler(const char *format, ...)
2574{
2575 va_list args;
2576 va_start(args, format);
2577 if (getenv("LIBSERIALPORT_DEBUG")) {
2578 fputs("sp: ", stderr);
2579 vfprintf(stderr, format, args);
2580 }
2581 va_end(args);
2582}
2583
2584SP_API int sp_get_major_package_version(void)
2585{
2586 return SP_PACKAGE_VERSION_MAJOR;
2587}
2588
2589SP_API int sp_get_minor_package_version(void)
2590{
2591 return SP_PACKAGE_VERSION_MINOR;
2592}
2593
2594SP_API int sp_get_micro_package_version(void)
2595{
2596 return SP_PACKAGE_VERSION_MICRO;
2597}
2598
2599SP_API const char *sp_get_package_version_string(void)
2600{
2601 return SP_PACKAGE_VERSION_STRING;
2602}
2603
2604SP_API int sp_get_current_lib_version(void)
2605{
2606 return SP_LIB_VERSION_CURRENT;
2607}
2608
2609SP_API int sp_get_revision_lib_version(void)
2610{
2611 return SP_LIB_VERSION_REVISION;
2612}
2613
2614SP_API int sp_get_age_lib_version(void)
2615{
2616 return SP_LIB_VERSION_AGE;
2617}
2618
2619SP_API const char *sp_get_lib_version_string(void)
2620{
2621 return SP_LIB_VERSION_STRING;
2622}
2623
2624/** @} */
Serial port access library