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