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