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