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