]> sigrok.org Git - libserialport.git/blame_incremental - serialport.c
Handle -EAGAIN in non-blocking reads on Unix, and return 0 from sp_read().
[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 *
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation, either version 3 of the
12 * License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 */
22
23#include <string.h>
24#include <sys/types.h>
25#include <sys/stat.h>
26#include <fcntl.h>
27#include <unistd.h>
28#include <stdlib.h>
29#include <errno.h>
30#include <stdio.h>
31#include <stdarg.h>
32#ifdef _WIN32
33#include <windows.h>
34#include <tchar.h>
35#include <stdio.h>
36#else
37#include <termios.h>
38#include <sys/ioctl.h>
39#endif
40#ifdef __APPLE__
41#include <IOKit/IOKitLib.h>
42#include <IOKit/serial/IOSerialKeys.h>
43#include <IOKit/serial/ioss.h>
44#include <sys/syslimits.h>
45#endif
46#ifdef __linux__
47#include "libudev.h"
48#include "linux/serial.h"
49#include "linux_termios.h"
50#if defined(TCGETX) && defined(TCSETX) && defined(HAVE_TERMIOX)
51#define USE_TERMIOX
52#endif
53#endif
54
55#ifndef _WIN32
56#include "linux_termios.h"
57#endif
58
59#include "libserialport.h"
60
61struct sp_port {
62 char *name;
63 int nonblocking;
64#ifdef _WIN32
65 HANDLE hdl;
66#else
67 int fd;
68#endif
69};
70
71struct sp_port_config {
72 int baudrate;
73 int bits;
74 enum sp_parity parity;
75 int stopbits;
76 enum sp_rts rts;
77 enum sp_cts cts;
78 enum sp_dtr dtr;
79 enum sp_dsr dsr;
80 enum sp_xonxoff xon_xoff;
81};
82
83struct port_data {
84#ifdef _WIN32
85 DCB dcb;
86#else
87 struct termios term;
88 int controlbits;
89 int termiox_supported;
90 int flow;
91#endif
92};
93
94/* Standard baud rates. */
95#ifdef _WIN32
96#define BAUD_TYPE DWORD
97#define BAUD(n) {CBR_##n, n}
98#else
99#define BAUD_TYPE speed_t
100#define BAUD(n) {B##n, n}
101#endif
102
103struct std_baudrate {
104 BAUD_TYPE index;
105 int value;
106};
107
108const struct std_baudrate std_baudrates[] = {
109#ifdef _WIN32
110 /*
111 * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
112 * have documented CBR_* macros.
113 */
114 BAUD(110), BAUD(300), BAUD(600), BAUD(1200), BAUD(2400), BAUD(4800),
115 BAUD(9600), BAUD(14400), BAUD(19200), BAUD(38400), BAUD(57600),
116 BAUD(115200), BAUD(128000), BAUD(256000),
117#else
118 BAUD(50), BAUD(75), BAUD(110), BAUD(134), BAUD(150), BAUD(200),
119 BAUD(300), BAUD(600), BAUD(1200), BAUD(1800), BAUD(2400), BAUD(4800),
120 BAUD(9600), BAUD(19200), BAUD(38400), BAUD(57600), BAUD(115200),
121 BAUD(230400),
122#if !defined(__APPLE__) && !defined(__OpenBSD__)
123 BAUD(460800),
124#endif
125#endif
126};
127
128void (*sp_debug_handler)(const char *format, ...) = sp_default_debug_handler;
129
130#define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
131#define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates)
132
133/* Debug output macros. */
134#define DEBUG(fmt, ...) do { if (sp_debug_handler) sp_debug_handler(fmt ".\n", ##__VA_ARGS__); } while (0)
135#define DEBUG_ERROR(err, msg) DEBUG("%s returning " #err ": " msg, __func__)
136#define DEBUG_FAIL(msg) do { \
137 char *errmsg = sp_last_error_message(); \
138 DEBUG("%s returning SP_ERR_FAIL: " msg ": %s", __func__, errmsg); \
139 sp_free_error_message(errmsg); \
140} while (0);
141#define RETURN() do { DEBUG("%s returning", __func__); return; } while(0)
142#define RETURN_CODE(x) do { DEBUG("%s returning " #x, __func__); return x; } while (0)
143#define RETURN_CODEVAL(x) do { \
144 switch (x) { \
145 case SP_OK: RETURN_CODE(SP_OK); \
146 case SP_ERR_ARG: RETURN_CODE(SP_ERR_ARG); \
147 case SP_ERR_FAIL: RETURN_CODE(SP_ERR_FAIL); \
148 case SP_ERR_MEM: RETURN_CODE(SP_ERR_MEM); \
149 case SP_ERR_SUPP: RETURN_CODE(SP_ERR_SUPP); \
150 } \
151} while (0)
152#define RETURN_OK() RETURN_CODE(SP_OK);
153#define RETURN_ERROR(err, msg) do { DEBUG_ERROR(err, msg); return err; } while (0)
154#define RETURN_FAIL(msg) do { DEBUG_FAIL(msg); return SP_ERR_FAIL; } while (0)
155#define RETURN_VALUE(fmt, x) do { DEBUG("%s returning " fmt, __func__, x); return x; } while (0)
156#define SET_ERROR(val, err, msg) do { DEBUG_ERROR(err, msg); val = err; } while (0)
157#define SET_FAIL(val, msg) do { DEBUG_FAIL(msg); val = err; } while (0)
158#define TRACE(fmt, ...) DEBUG("%s(" fmt ") called", __func__, ##__VA_ARGS__)
159
160#define TRY(x) do { int ret = x; if (ret != SP_OK) RETURN_CODEVAL(ret); } while (0)
161
162/* Helper functions. */
163static struct sp_port **list_append(struct sp_port **list, const char *portname);
164static enum sp_return get_config(struct sp_port *port, struct port_data *data,
165 struct sp_port_config *config);
166static enum sp_return set_config(struct sp_port *port, struct port_data *data,
167 const struct sp_port_config *config);
168
169enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
170{
171 struct sp_port *port;
172 int len;
173
174 TRACE("%s, %p", portname, port_ptr);
175
176 if (!port_ptr)
177 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
178
179 *port_ptr = NULL;
180
181 if (!portname)
182 RETURN_ERROR(SP_ERR_ARG, "Null port name");
183
184 DEBUG("Building structure for port %s", portname);
185
186 if (!(port = malloc(sizeof(struct sp_port))))
187 RETURN_ERROR(SP_ERR_MEM, "Port structure malloc failed");
188
189 len = strlen(portname) + 1;
190
191 if (!(port->name = malloc(len))) {
192 free(port);
193 RETURN_ERROR(SP_ERR_MEM, "Port name malloc failed");
194 }
195
196 memcpy(port->name, portname, len);
197
198#ifdef _WIN32
199 port->hdl = INVALID_HANDLE_VALUE;
200#else
201 port->fd = -1;
202#endif
203
204 *port_ptr = port;
205
206 RETURN_OK();
207}
208
209char *sp_get_port_name(const struct sp_port *port)
210{
211 TRACE("%p", port);
212
213 if (!port)
214 return NULL;
215
216 RETURN_VALUE("%s", port->name);
217}
218
219enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr)
220{
221 TRACE("%p", port);
222
223 if (!port)
224 RETURN_ERROR(SP_ERR_ARG, "Null port");
225
226#ifdef _WIN32
227 HANDLE *handle_ptr = result_ptr;
228 *handle_ptr = port->hdl;
229#else
230 int *fd_ptr = result_ptr;
231 *fd_ptr = port->fd;
232#endif
233
234 RETURN_OK();
235}
236
237enum sp_return sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr)
238{
239 TRACE("%p, %p", port, copy_ptr);
240
241 if (!copy_ptr)
242 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
243
244 *copy_ptr = NULL;
245
246 if (!port)
247 RETURN_ERROR(SP_ERR_ARG, "Null port");
248
249 if (!port->name)
250 RETURN_ERROR(SP_ERR_ARG, "Null port name");
251
252 DEBUG("Copying port structure");
253
254 RETURN_VALUE("%p", sp_get_port_by_name(port->name, copy_ptr));
255}
256
257void sp_free_port(struct sp_port *port)
258{
259 TRACE("%p", port);
260
261 if (!port)
262 {
263 DEBUG("Null port");
264 RETURN();
265 }
266
267 DEBUG("Freeing port structure");
268
269 if (port->name)
270 free(port->name);
271
272 free(port);
273
274 RETURN();
275}
276
277static struct sp_port **list_append(struct sp_port **list, const char *portname)
278{
279 void *tmp;
280 unsigned int count;
281
282 for (count = 0; list[count]; count++);
283 if (!(tmp = realloc(list, sizeof(struct sp_port *) * (count + 2))))
284 goto fail;
285 list = tmp;
286 if (sp_get_port_by_name(portname, &list[count]) != SP_OK)
287 goto fail;
288 list[count + 1] = NULL;
289 return list;
290
291fail:
292 sp_free_port_list(list);
293 return NULL;
294}
295
296enum sp_return sp_list_ports(struct sp_port ***list_ptr)
297{
298 struct sp_port **list;
299 int ret = SP_ERR_SUPP;
300
301 TRACE("%p", list_ptr);
302
303 if (!list_ptr)
304 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
305
306 DEBUG("Enumerating ports");
307
308 if (!(list = malloc(sizeof(struct sp_port **))))
309 RETURN_ERROR(SP_ERR_MEM, "Port list malloc failed");
310
311 list[0] = NULL;
312
313#ifdef _WIN32
314 HKEY key;
315 TCHAR *value, *data;
316 DWORD max_value_len, max_data_size, max_data_len;
317 DWORD value_len, data_size, data_len;
318 DWORD type, index = 0;
319 char *name;
320 int name_len;
321
322 ret = SP_OK;
323
324 DEBUG("Opening registry key");
325 if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T("HARDWARE\\DEVICEMAP\\SERIALCOMM"),
326 0, KEY_QUERY_VALUE, &key) != ERROR_SUCCESS) {
327 SET_FAIL(ret, "RegOpenKeyEx() failed");
328 goto out_done;
329 }
330 DEBUG("Querying registry key value and data sizes");
331 if (RegQueryInfoKey(key, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
332 &max_value_len, &max_data_size, NULL, NULL) != ERROR_SUCCESS) {
333 SET_FAIL(ret, "RegQueryInfoKey() failed");
334 goto out_close;
335 }
336 max_data_len = max_data_size / sizeof(TCHAR);
337 if (!(value = malloc((max_value_len + 1) * sizeof(TCHAR)))) {
338 SET_ERROR(ret, SP_ERR_MEM, "registry value malloc failed");
339 goto out_close;
340 }
341 if (!(data = malloc((max_data_len + 1) * sizeof(TCHAR)))) {
342 SET_ERROR(ret, SP_ERR_MEM, "registry data malloc failed");
343 goto out_free_value;
344 }
345 DEBUG("Iterating over values");
346 while (
347 value_len = max_value_len + 1,
348 data_size = max_data_size,
349 RegEnumValue(key, index, value, &value_len,
350 NULL, &type, (LPBYTE)data, &data_size) == ERROR_SUCCESS)
351 {
352 data_len = data_size / sizeof(TCHAR);
353 data[data_len] = '\0';
354#ifdef UNICODE
355 name_len = WideCharToMultiByte(CP_ACP, 0, data, -1, NULL, 0, NULL, NULL)
356#else
357 name_len = data_len + 1;
358#endif
359 if (!(name = malloc(name_len))) {
360 SET_ERROR(ret, SP_ERR_MEM, "registry port name malloc failed");
361 goto out;
362 }
363#ifdef UNICODE
364 WideCharToMultiByte(CP_ACP, 0, data, -1, name, name_len, NULL, NULL);
365#else
366 strcpy(name, data);
367#endif
368 if (type == REG_SZ) {
369 DEBUG("Found port %s", name);
370 if (!(list = list_append(list, name))) {
371 SET_ERROR(ret, SP_ERR_MEM, "list append failed");
372 goto out;
373 }
374 }
375 index++;
376 }
377out:
378 free(data);
379out_free_value:
380 free(value);
381out_close:
382 RegCloseKey(key);
383out_done:
384#endif
385#ifdef __APPLE__
386 mach_port_t master;
387 CFMutableDictionaryRef classes;
388 io_iterator_t iter;
389 char *path;
390 io_object_t port;
391 CFTypeRef cf_path;
392 Boolean result;
393
394 ret = SP_OK;
395
396 DEBUG("Getting IOKit master port");
397 if (IOMasterPort(MACH_PORT_NULL, &master) != KERN_SUCCESS) {
398 SET_FAIL(ret, "IOMasterPort() failed");
399 goto out_done;
400 }
401
402 DEBUG("Creating matching dictionary");
403 if (!(classes = IOServiceMatching(kIOSerialBSDServiceValue))) {
404 SET_FAIL(ret, "IOServiceMatching() failed");
405 goto out_done;
406 }
407
408 CFDictionarySetValue(classes,
409 CFSTR(kIOSerialBSDTypeKey), CFSTR(kIOSerialBSDAllTypes));
410
411 DEBUG("Getting matching services");
412 if (IOServiceGetMatchingServices(master, classes, &iter) != KERN_SUCCESS) {
413 SET_FAIL(ret, "IOServiceGetMatchingServices() failed");
414 goto out_done;
415 }
416
417 if (!(path = malloc(PATH_MAX))) {
418 SET_ERROR(ret, SP_ERR_MEM, "device path malloc failed");
419 goto out_release;
420 }
421
422 DEBUG("Iterating over results");
423 while ((port = IOIteratorNext(iter))) {
424 cf_path = IORegistryEntryCreateCFProperty(port,
425 CFSTR(kIOCalloutDeviceKey), kCFAllocatorDefault, 0);
426 if (cf_path) {
427 result = CFStringGetCString(cf_path,
428 path, PATH_MAX, kCFStringEncodingASCII);
429 CFRelease(cf_path);
430 if (result) {
431 DEBUG("Found port %s", path);
432 if (!(list = list_append(list, path))) {
433 SET_ERROR(ret, SP_ERR_MEM, "list append failed");
434 IOObjectRelease(port);
435 goto out;
436 }
437 }
438 }
439 IOObjectRelease(port);
440 }
441out:
442 free(path);
443out_release:
444 IOObjectRelease(iter);
445out_done:
446#endif
447#ifdef __linux__
448 struct udev *ud;
449 struct udev_enumerate *ud_enumerate;
450 struct udev_list_entry *ud_list;
451 struct udev_list_entry *ud_entry;
452 const char *path;
453 struct udev_device *ud_dev, *ud_parent;
454 const char *name;
455 const char *driver;
456 int fd, ioctl_result;
457 struct serial_struct serial_info;
458
459 ret = SP_OK;
460
461 DEBUG("Enumerating tty devices");
462 ud = udev_new();
463 ud_enumerate = udev_enumerate_new(ud);
464 udev_enumerate_add_match_subsystem(ud_enumerate, "tty");
465 udev_enumerate_scan_devices(ud_enumerate);
466 ud_list = udev_enumerate_get_list_entry(ud_enumerate);
467 DEBUG("Iterating over results");
468 udev_list_entry_foreach(ud_entry, ud_list) {
469 path = udev_list_entry_get_name(ud_entry);
470 DEBUG("Found device %s", path);
471 ud_dev = udev_device_new_from_syspath(ud, path);
472 /* If there is no parent device, this is a virtual tty. */
473 ud_parent = udev_device_get_parent(ud_dev);
474 if (ud_parent == NULL) {
475 DEBUG("No parent device, assuming virtual tty");
476 udev_device_unref(ud_dev);
477 continue;
478 }
479 name = udev_device_get_devnode(ud_dev);
480 /* The serial8250 driver has a hardcoded number of ports.
481 * The only way to tell which actually exist on a given system
482 * is to try to open them and make an ioctl call. */
483 driver = udev_device_get_driver(ud_parent);
484 if (driver && !strcmp(driver, "serial8250")) {
485 DEBUG("serial8250 device, attempting to open");
486 if ((fd = open(name, O_RDWR | O_NONBLOCK | O_NOCTTY)) < 0) {
487 DEBUG("open failed, skipping");
488 goto skip;
489 }
490 ioctl_result = ioctl(fd, TIOCGSERIAL, &serial_info);
491 close(fd);
492 if (ioctl_result != 0) {
493 DEBUG("ioctl failed, skipping");
494 goto skip;
495 }
496 if (serial_info.type == PORT_UNKNOWN) {
497 DEBUG("port type is unknown, skipping");
498 goto skip;
499 }
500 }
501 DEBUG("Found port %s", name);
502 list = list_append(list, name);
503skip:
504 udev_device_unref(ud_dev);
505 if (!list) {
506 SET_ERROR(ret, SP_ERR_MEM, "list append failed");
507 goto out;
508 }
509 }
510out:
511 udev_enumerate_unref(ud_enumerate);
512 udev_unref(ud);
513#endif
514
515 switch (ret) {
516 case SP_OK:
517 *list_ptr = list;
518 RETURN_OK();
519 case SP_ERR_SUPP:
520 DEBUG_ERROR(SP_ERR_SUPP, "Enumeration not supported on this platform.");
521 default:
522 if (list)
523 sp_free_port_list(list);
524 *list_ptr = NULL;
525 return ret;
526 }
527}
528
529void sp_free_port_list(struct sp_port **list)
530{
531 unsigned int i;
532
533 TRACE("%p", list);
534
535 if (!list) {
536 DEBUG("Null list");
537 RETURN();
538 }
539
540 DEBUG("Freeing port list");
541
542 for (i = 0; list[i]; i++)
543 sp_free_port(list[i]);
544 free(list);
545
546 RETURN();
547}
548
549#define CHECK_PORT() do { \
550 if (port == NULL) \
551 RETURN_ERROR(SP_ERR_ARG, "Null port"); \
552 if (port->name == NULL) \
553 RETURN_ERROR(SP_ERR_ARG, "Null port name"); \
554} while (0)
555#ifdef _WIN32
556#define CHECK_PORT_HANDLE() do { \
557 if (port->hdl == INVALID_HANDLE_VALUE) \
558 RETURN_ERROR(SP_ERR_ARG, "Invalid port handle"); \
559} while (0)
560#else
561#define CHECK_PORT_HANDLE() do { \
562 if (port->fd < 0) \
563 RETURN_ERROR(SP_ERR_ARG, "Invalid port fd"); \
564} while (0)
565#endif
566#define CHECK_OPEN_PORT() do { \
567 CHECK_PORT(); \
568 CHECK_PORT_HANDLE(); \
569} while (0)
570
571enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
572{
573 TRACE("%p, %x", port, flags);
574
575 CHECK_PORT();
576
577 if (flags > (SP_MODE_READ | SP_MODE_WRITE | SP_MODE_NONBLOCK))
578 RETURN_ERROR(SP_ERR_ARG, "Invalid flags");
579
580 DEBUG("Opening port %s", port->name);
581
582 port->nonblocking = (flags & SP_MODE_NONBLOCK) ? 1 : 0;
583
584#ifdef _WIN32
585 DWORD desired_access = 0, flags_and_attributes = 0;
586 char *escaped_port_name;
587
588 /* Prefix port name with '\\.\' to work with ports above COM9. */
589 if (!(escaped_port_name = malloc(strlen(port->name + 5))))
590 RETURN_ERROR(SP_ERR_MEM, "Escaped port name malloc failed");
591 sprintf(escaped_port_name, "\\\\.\\%s", port->name);
592
593 /* Map 'flags' to the OS-specific settings. */
594 flags_and_attributes = FILE_ATTRIBUTE_NORMAL;
595 if (flags & SP_MODE_READ)
596 desired_access |= GENERIC_READ;
597 if (flags & SP_MODE_WRITE)
598 desired_access |= GENERIC_WRITE;
599 if (flags & SP_MODE_NONBLOCK)
600 flags_and_attributes |= FILE_FLAG_OVERLAPPED;
601
602 port->hdl = CreateFile(escaped_port_name, desired_access, 0, 0,
603 OPEN_EXISTING, flags_and_attributes, 0);
604
605 free(escaped_port_name);
606
607 if (port->hdl == INVALID_HANDLE_VALUE)
608 RETURN_FAIL("CreateFile() failed");
609#else
610 int flags_local = 0;
611 struct port_data data;
612 struct sp_port_config config;
613 int ret;
614
615 /* Map 'flags' to the OS-specific settings. */
616 if (flags & (SP_MODE_READ | SP_MODE_WRITE))
617 flags_local |= O_RDWR;
618 else if (flags & SP_MODE_READ)
619 flags_local |= O_RDONLY;
620 else if (flags & SP_MODE_WRITE)
621 flags_local |= O_WRONLY;
622 if (flags & SP_MODE_NONBLOCK)
623 flags_local |= O_NONBLOCK;
624
625 if ((port->fd = open(port->name, flags_local)) < 0)
626 RETURN_FAIL("open() failed");
627
628 ret = get_config(port, &data, &config);
629
630 if (ret < 0) {
631 sp_close(port);
632 RETURN_CODEVAL(ret);
633 }
634
635 /* Turn off all serial port cooking. */
636 data.term.c_iflag &= ~(ISTRIP | INLCR | ICRNL);
637 data.term.c_oflag &= ~(ONLCR | OCRNL | ONOCR);
638#if !defined(__FreeBSD__) && !defined(__OpenBSD__) && !defined(__NetBSD__)
639 data.term.c_oflag &= ~OFILL;
640#endif
641 /* Disable canonical mode, and don't echo input characters. */
642 data.term.c_lflag &= ~(ICANON | ECHO);
643
644 /* Ignore modem status lines; enable receiver */
645 data.term.c_cflag |= (CLOCAL | CREAD);
646
647 ret = set_config(port, &data, &config);
648
649 if (ret < 0) {
650 sp_close(port);
651 RETURN_CODEVAL(ret);
652 }
653#endif
654
655 RETURN_OK();
656}
657
658enum sp_return sp_close(struct sp_port *port)
659{
660 TRACE("%p", port);
661
662 CHECK_OPEN_PORT();
663
664 DEBUG("Closing port %s", port->name);
665
666#ifdef _WIN32
667 /* Returns non-zero upon success, 0 upon failure. */
668 if (CloseHandle(port->hdl) == 0)
669 RETURN_FAIL("CloseHandle() failed");
670 port->hdl = INVALID_HANDLE_VALUE;
671#else
672 /* Returns 0 upon success, -1 upon failure. */
673 if (close(port->fd) == -1)
674 RETURN_FAIL("close() failed");
675 port->fd = -1;
676#endif
677
678 RETURN_OK();
679}
680
681enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers)
682{
683 TRACE("%p, %x", port, buffers);
684
685 CHECK_OPEN_PORT();
686
687 if (buffers > SP_BUF_BOTH)
688 RETURN_ERROR(SP_ERR_ARG, "Invalid buffer selection");
689
690 const char *buffer_names[] = {"no", "input", "output", "both"};
691
692 DEBUG("Flushing %s buffers on port %s", buffer_names[buffers], port->name);
693
694#ifdef _WIN32
695 DWORD flags = 0;
696 if (buffers & SP_BUF_INPUT)
697 flags |= PURGE_RXCLEAR;
698 if (buffers & SP_BUF_OUTPUT)
699 flags |= PURGE_TXCLEAR;
700
701 /* Returns non-zero upon success, 0 upon failure. */
702 if (PurgeComm(port->hdl, flags) == 0)
703 RETURN_FAIL("PurgeComm() failed");
704#else
705 int flags = 0;
706 if (buffers & SP_BUF_BOTH)
707 flags = TCIOFLUSH;
708 else if (buffers & SP_BUF_INPUT)
709 flags = TCIFLUSH;
710 else if (buffers & SP_BUF_OUTPUT)
711 flags = TCOFLUSH;
712
713 /* Returns 0 upon success, -1 upon failure. */
714 if (tcflush(port->fd, flags) < 0)
715 RETURN_FAIL("tcflush() failed");
716#endif
717 RETURN_OK();
718}
719
720enum sp_return sp_drain(struct sp_port *port)
721{
722 TRACE("%p", port);
723
724 CHECK_OPEN_PORT();
725
726 DEBUG("Draining port %s", port->name);
727
728#ifdef _WIN32
729 /* Returns non-zero upon success, 0 upon failure. */
730 if (FlushFileBuffers(port->hdl) == 0)
731 RETURN_FAIL("FlushFileBuffers() failed");
732#else
733 /* Returns 0 upon success, -1 upon failure. */
734 if (tcdrain(port->fd) < 0)
735 RETURN_FAIL("tcdrain() failed");
736#endif
737
738 RETURN_OK();
739}
740
741enum sp_return sp_write(struct sp_port *port, const void *buf, size_t count)
742{
743 TRACE("%p, %p, %d", port, buf, count);
744
745 CHECK_OPEN_PORT();
746
747 if (!buf)
748 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
749
750 DEBUG("Writing up to %d bytes to port %s", count, port->name);
751
752#ifdef _WIN32
753 DWORD written = 0;
754
755 /* Returns non-zero upon success, 0 upon failure. */
756 if (WriteFile(port->hdl, buf, count, &written, NULL) == 0)
757 RETURN_FAIL("WriteFile() failed");
758 RETURN_VALUE("%d", written);
759#else
760 /* Returns the number of bytes written, or -1 upon failure. */
761 ssize_t written = write(port->fd, buf, count);
762
763 if (written < 0)
764 RETURN_FAIL("write() failed");
765 else
766 RETURN_VALUE("%d", written);
767#endif
768}
769
770enum sp_return sp_read(struct sp_port *port, void *buf, size_t count)
771{
772 TRACE("%p, %p, %d", port, buf, count);
773
774 CHECK_OPEN_PORT();
775
776 if (!buf)
777 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
778
779 DEBUG("Reading up to %d bytes from port %s", count, port->name);
780
781#ifdef _WIN32
782 DWORD bytes_read = 0;
783
784 /* Returns non-zero upon success, 0 upon failure. */
785 if (ReadFile(port->hdl, buf, count, &bytes_read, NULL) == 0)
786 RETURN_FAIL("ReadFile() failed");
787 RETURN_VALUE("%d", bytes_read);
788#else
789 ssize_t bytes_read;
790
791 /* Returns the number of bytes read, or -1 upon failure. */
792 if ((bytes_read = read(port->fd, buf, count)) < 0) {
793 if (port->nonblocking && errno == EAGAIN)
794 /* Port is opened in nonblocking mode and there are no bytes available. */
795 bytes_read = 0;
796 else
797 /* This is an actual failure. */
798 RETURN_FAIL("read() failed");
799 }
800 RETURN_VALUE("%d", bytes_read);
801#endif
802}
803
804#ifdef __linux__
805static enum sp_return get_baudrate(int fd, int *baudrate)
806{
807 void *data;
808
809 TRACE("%d, %p", fd, baudrate);
810
811 DEBUG("Getting baud rate");
812
813 if (!(data = malloc(get_termios_size())))
814 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
815
816 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
817 free(data);
818 RETURN_FAIL("getting termios failed");
819 }
820
821 *baudrate = get_termios_speed(data);
822
823 free(data);
824
825 RETURN_OK();
826}
827
828static enum sp_return set_baudrate(int fd, int baudrate)
829{
830 void *data;
831
832 TRACE("%d, %d", fd, baudrate);
833
834 DEBUG("Getting baud rate");
835
836 if (!(data = malloc(get_termios_size())))
837 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
838
839 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
840 free(data);
841 RETURN_FAIL("getting termios failed");
842 }
843
844 DEBUG("Setting baud rate");
845
846 set_termios_speed(data, baudrate);
847
848 if (ioctl(fd, get_termios_set_ioctl(), data) < 0) {
849 free(data);
850 RETURN_FAIL("setting termios failed");
851 }
852
853 free(data);
854
855 RETURN_OK();
856}
857
858#ifdef USE_TERMIOX
859static enum sp_return get_flow(int fd, int *flow)
860{
861 void *data;
862
863 TRACE("%d, %p", fd, flow);
864
865 DEBUG("Getting advanced flow control");
866
867 if (!(data = malloc(get_termiox_size())))
868 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
869
870 if (ioctl(fd, TCGETX, data) < 0) {
871 free(data);
872 RETURN_FAIL("getting termiox failed");
873 }
874
875 *flow = get_termiox_flow(data);
876
877 free(data);
878
879 RETURN_OK();
880}
881
882static enum sp_return set_flow(int fd, int flow)
883{
884 void *data;
885
886 TRACE("%d, %d", fd, flow);
887
888 DEBUG("Getting advanced flow control");
889
890 if (!(data = malloc(get_termiox_size())))
891 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
892
893 if (ioctl(fd, TCGETX, data) < 0) {
894 free(data);
895 RETURN_FAIL("getting termiox failed");
896 }
897
898 DEBUG("Setting advanced flow control");
899
900 set_termiox_flow(data, flow);
901
902 if (ioctl(fd, TCSETX, data) < 0) {
903 free(data);
904 RETURN_FAIL("setting termiox failed");
905 }
906
907 free(data);
908
909 RETURN_OK();
910}
911#endif /* USE_TERMIOX */
912#endif /* __linux__ */
913
914static enum sp_return get_config(struct sp_port *port, struct port_data *data,
915 struct sp_port_config *config)
916{
917 unsigned int i;
918
919 TRACE("%p, %p, %p", port, data, config);
920
921 DEBUG("Getting configuration for port %s", port->name);
922
923#ifdef _WIN32
924 if (!GetCommState(port->hdl, &data->dcb))
925 RETURN_FAIL("GetCommState() failed");
926
927 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
928 if (data->dcb.BaudRate == std_baudrates[i].index) {
929 config->baudrate = std_baudrates[i].value;
930 break;
931 }
932 }
933
934 if (i == NUM_STD_BAUDRATES)
935 /* BaudRate field can be either an index or a custom baud rate. */
936 config->baudrate = data->dcb.BaudRate;
937
938 config->bits = data->dcb.ByteSize;
939
940 if (data->dcb.fParity)
941 switch (data->dcb.Parity) {
942 case NOPARITY:
943 config->parity = SP_PARITY_NONE;
944 break;
945 case EVENPARITY:
946 config->parity = SP_PARITY_EVEN;
947 break;
948 case ODDPARITY:
949 config->parity = SP_PARITY_ODD;
950 break;
951 default:
952 config->parity = -1;
953 }
954 else
955 config->parity = SP_PARITY_NONE;
956
957 switch (data->dcb.StopBits) {
958 case ONESTOPBIT:
959 config->stopbits = 1;
960 break;
961 case TWOSTOPBITS:
962 config->stopbits = 2;
963 break;
964 default:
965 config->stopbits = -1;
966 }
967
968 switch (data->dcb.fRtsControl) {
969 case RTS_CONTROL_DISABLE:
970 config->rts = SP_RTS_OFF;
971 break;
972 case RTS_CONTROL_ENABLE:
973 config->rts = SP_RTS_ON;
974 break;
975 case RTS_CONTROL_HANDSHAKE:
976 config->rts = SP_RTS_FLOW_CONTROL;
977 break;
978 default:
979 config->rts = -1;
980 }
981
982 config->cts = data->dcb.fOutxCtsFlow ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
983
984 switch (data->dcb.fDtrControl) {
985 case DTR_CONTROL_DISABLE:
986 config->dtr = SP_DTR_OFF;
987 break;
988 case DTR_CONTROL_ENABLE:
989 config->dtr = SP_DTR_ON;
990 break;
991 case DTR_CONTROL_HANDSHAKE:
992 config->dtr = SP_DTR_FLOW_CONTROL;
993 break;
994 default:
995 config->dtr = -1;
996 }
997
998 config->dsr = data->dcb.fOutxDsrFlow ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
999
1000 if (data->dcb.fInX) {
1001 if (data->dcb.fOutX)
1002 config->xon_xoff = SP_XONXOFF_INOUT;
1003 else
1004 config->xon_xoff = SP_XONXOFF_IN;
1005 } else {
1006 if (data->dcb.fOutX)
1007 config->xon_xoff = SP_XONXOFF_OUT;
1008 else
1009 config->xon_xoff = SP_XONXOFF_DISABLED;
1010 }
1011
1012#else // !_WIN32
1013
1014 if (tcgetattr(port->fd, &data->term) < 0)
1015 RETURN_FAIL("tcgetattr() failed");
1016
1017 if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0)
1018 RETURN_FAIL("TIOCMGET ioctl failed");
1019
1020#ifdef USE_TERMIOX
1021 int ret = get_flow(port->fd, &data->flow);
1022
1023 if (ret == SP_ERR_FAIL && errno == EINVAL)
1024 data->termiox_supported = 0;
1025 else if (ret < 0)
1026 RETURN_CODEVAL(ret);
1027 else
1028 data->termiox_supported = 1;
1029#else
1030 data->termiox_supported = 0;
1031#endif
1032
1033 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1034 if (cfgetispeed(&data->term) == std_baudrates[i].index) {
1035 config->baudrate = std_baudrates[i].value;
1036 break;
1037 }
1038 }
1039
1040 if (i == NUM_STD_BAUDRATES) {
1041#ifdef __APPLE__
1042 config->baudrate = (int)data->term.c_ispeed;
1043#elif defined(__linux__)
1044 TRY(get_baudrate(port->fd, &config->baudrate));
1045#else
1046 config->baudrate = -1;
1047#endif
1048 }
1049
1050 switch (data->term.c_cflag & CSIZE) {
1051 case CS8:
1052 config->bits = 8;
1053 break;
1054 case CS7:
1055 config->bits = 7;
1056 break;
1057 case CS6:
1058 config->bits = 6;
1059 break;
1060 case CS5:
1061 config->bits = 5;
1062 break;
1063 default:
1064 config->bits = -1;
1065 }
1066
1067 if (!(data->term.c_cflag & PARENB) && (data->term.c_iflag & IGNPAR))
1068 config->parity = SP_PARITY_NONE;
1069 else if (!(data->term.c_cflag & PARENB) || (data->term.c_iflag & IGNPAR))
1070 config->parity = -1;
1071 else
1072 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_ODD : SP_PARITY_EVEN;
1073
1074 config->stopbits = (data->term.c_cflag & CSTOPB) ? 2 : 1;
1075
1076 if (data->term.c_cflag & CRTSCTS) {
1077 config->rts = SP_RTS_FLOW_CONTROL;
1078 config->cts = SP_CTS_FLOW_CONTROL;
1079 } else {
1080 if (data->termiox_supported && data->flow & RTS_FLOW)
1081 config->rts = SP_RTS_FLOW_CONTROL;
1082 else
1083 config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
1084
1085 config->cts = (data->termiox_supported && data->flow & CTS_FLOW) ?
1086 SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1087 }
1088
1089 if (data->termiox_supported && data->flow & DTR_FLOW)
1090 config->dtr = SP_DTR_FLOW_CONTROL;
1091 else
1092 config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
1093
1094 config->dsr = (data->termiox_supported && data->flow & DSR_FLOW) ?
1095 SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1096
1097 if (data->term.c_iflag & IXOFF) {
1098 if (data->term.c_iflag & IXON)
1099 config->xon_xoff = SP_XONXOFF_INOUT;
1100 else
1101 config->xon_xoff = SP_XONXOFF_IN;
1102 } else {
1103 if (data->term.c_iflag & IXON)
1104 config->xon_xoff = SP_XONXOFF_OUT;
1105 else
1106 config->xon_xoff = SP_XONXOFF_DISABLED;
1107 }
1108#endif
1109
1110 RETURN_OK();
1111}
1112
1113static enum sp_return set_config(struct sp_port *port, struct port_data *data,
1114 const struct sp_port_config *config)
1115{
1116 unsigned int i;
1117#ifdef __APPLE__
1118 BAUD_TYPE baud_nonstd;
1119
1120 baud_nonstd = B0;
1121#endif
1122#ifdef __linux__
1123 int baud_nonstd = 0;
1124#endif
1125
1126 TRACE("%p, %p, %p", port, data, config);
1127
1128 DEBUG("Setting configuration for port %s", port->name);
1129
1130#ifdef _WIN32
1131 if (config->baudrate >= 0) {
1132 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1133 if (config->baudrate == std_baudrates[i].value) {
1134 data->dcb.BaudRate = std_baudrates[i].index;
1135 break;
1136 }
1137 }
1138
1139 if (i == NUM_STD_BAUDRATES)
1140 data->dcb.BaudRate = config->baudrate;
1141 }
1142
1143 if (config->bits >= 0)
1144 data->dcb.ByteSize = config->bits;
1145
1146 if (config->parity >= 0) {
1147 switch (config->parity) {
1148 /* Note: There's also SPACEPARITY, MARKPARITY (unneeded so far). */
1149 case SP_PARITY_NONE:
1150 data->dcb.Parity = NOPARITY;
1151 break;
1152 case SP_PARITY_EVEN:
1153 data->dcb.Parity = EVENPARITY;
1154 break;
1155 case SP_PARITY_ODD:
1156 data->dcb.Parity = ODDPARITY;
1157 break;
1158 default:
1159 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1160 }
1161 }
1162
1163 if (config->stopbits >= 0) {
1164 switch (config->stopbits) {
1165 /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
1166 case 1:
1167 data->dcb.StopBits = ONESTOPBIT;
1168 break;
1169 case 2:
1170 data->dcb.StopBits = TWOSTOPBITS;
1171 break;
1172 default:
1173 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bit setting");
1174 }
1175 }
1176
1177 if (config->rts >= 0) {
1178 switch (config->rts) {
1179 case SP_RTS_OFF:
1180 data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
1181 break;
1182 case SP_RTS_ON:
1183 data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
1184 break;
1185 case SP_RTS_FLOW_CONTROL:
1186 data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
1187 break;
1188 default:
1189 RETURN_ERROR(SP_ERR_ARG, "Invalid RTS setting");
1190 }
1191 }
1192
1193 if (config->cts >= 0) {
1194 switch (config->cts) {
1195 case SP_CTS_IGNORE:
1196 data->dcb.fOutxCtsFlow = FALSE;
1197 break;
1198 case SP_CTS_FLOW_CONTROL:
1199 data->dcb.fOutxCtsFlow = TRUE;
1200 break;
1201 default:
1202 RETURN_ERROR(SP_ERR_ARG, "Invalid CTS setting");
1203 }
1204 }
1205
1206 if (config->dtr >= 0) {
1207 switch (config->dtr) {
1208 case SP_DTR_OFF:
1209 data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
1210 break;
1211 case SP_DTR_ON:
1212 data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
1213 break;
1214 case SP_DTR_FLOW_CONTROL:
1215 data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
1216 break;
1217 default:
1218 RETURN_ERROR(SP_ERR_ARG, "Invalid DTR setting");
1219 }
1220 }
1221
1222 if (config->dsr >= 0) {
1223 switch (config->dsr) {
1224 case SP_DSR_IGNORE:
1225 data->dcb.fOutxDsrFlow = FALSE;
1226 break;
1227 case SP_DSR_FLOW_CONTROL:
1228 data->dcb.fOutxDsrFlow = TRUE;
1229 break;
1230 default:
1231 RETURN_ERROR(SP_ERR_ARG, "Invalid DSR setting");
1232 }
1233 }
1234
1235 if (config->xon_xoff >= 0) {
1236 switch (config->xon_xoff) {
1237 case SP_XONXOFF_DISABLED:
1238 data->dcb.fInX = FALSE;
1239 data->dcb.fOutX = FALSE;
1240 break;
1241 case SP_XONXOFF_IN:
1242 data->dcb.fInX = TRUE;
1243 data->dcb.fOutX = FALSE;
1244 break;
1245 case SP_XONXOFF_OUT:
1246 data->dcb.fInX = FALSE;
1247 data->dcb.fOutX = TRUE;
1248 break;
1249 case SP_XONXOFF_INOUT:
1250 data->dcb.fInX = TRUE;
1251 data->dcb.fOutX = TRUE;
1252 break;
1253 default:
1254 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
1255 }
1256 }
1257
1258 if (!SetCommState(port->hdl, &data->dcb))
1259 RETURN_FAIL("SetCommState() failed");
1260
1261#else /* !_WIN32 */
1262
1263 int controlbits;
1264
1265 if (config->baudrate >= 0) {
1266 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1267 if (config->baudrate == std_baudrates[i].value) {
1268 if (cfsetospeed(&data->term, std_baudrates[i].index) < 0)
1269 RETURN_FAIL("cfsetospeed() failed");
1270
1271 if (cfsetispeed(&data->term, std_baudrates[i].index) < 0)
1272 RETURN_FAIL("cfsetispeed() failed");
1273 break;
1274 }
1275 }
1276
1277 /* Non-standard baud rate */
1278 if (i == NUM_STD_BAUDRATES) {
1279#ifdef __APPLE__
1280 /* Set "dummy" baud rate. */
1281 if (cfsetspeed(&data->term, B9600) < 0)
1282 RETURN_FAIL("cfsetspeed() failed");
1283 baud_nonstd = config->baudrate;
1284#elif defined(__linux__)
1285 baud_nonstd = 1;
1286#else
1287 RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported");
1288#endif
1289 }
1290 }
1291
1292 if (config->bits >= 0) {
1293 data->term.c_cflag &= ~CSIZE;
1294 switch (config->bits) {
1295 case 8:
1296 data->term.c_cflag |= CS8;
1297 break;
1298 case 7:
1299 data->term.c_cflag |= CS7;
1300 break;
1301 case 6:
1302 data->term.c_cflag |= CS6;
1303 break;
1304 case 5:
1305 data->term.c_cflag |= CS5;
1306 break;
1307 default:
1308 RETURN_ERROR(SP_ERR_ARG, "Invalid data bits setting");
1309 }
1310 }
1311
1312 if (config->parity >= 0) {
1313 data->term.c_iflag &= ~IGNPAR;
1314 data->term.c_cflag &= ~(PARENB | PARODD);
1315 switch (config->parity) {
1316 case SP_PARITY_NONE:
1317 data->term.c_iflag |= IGNPAR;
1318 break;
1319 case SP_PARITY_EVEN:
1320 data->term.c_cflag |= PARENB;
1321 break;
1322 case SP_PARITY_ODD:
1323 data->term.c_cflag |= PARENB | PARODD;
1324 break;
1325 default:
1326 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1327 }
1328 }
1329
1330 if (config->stopbits >= 0) {
1331 data->term.c_cflag &= ~CSTOPB;
1332 switch (config->stopbits) {
1333 case 1:
1334 data->term.c_cflag &= ~CSTOPB;
1335 break;
1336 case 2:
1337 data->term.c_cflag |= CSTOPB;
1338 break;
1339 default:
1340 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bits setting");
1341 }
1342 }
1343
1344 if (config->rts >= 0 || config->cts >= 0) {
1345 if (data->termiox_supported) {
1346 data->flow &= ~(RTS_FLOW | CTS_FLOW);
1347 switch (config->rts) {
1348 case SP_RTS_OFF:
1349 case SP_RTS_ON:
1350 controlbits = TIOCM_RTS;
1351 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
1352 RETURN_FAIL("Setting RTS signal level failed");
1353 break;
1354 case SP_RTS_FLOW_CONTROL:
1355 data->flow |= RTS_FLOW;
1356 break;
1357 default:
1358 break;
1359 }
1360 if (config->cts == SP_CTS_FLOW_CONTROL)
1361 data->flow |= CTS_FLOW;
1362
1363 if (data->flow & (RTS_FLOW | CTS_FLOW))
1364 data->term.c_iflag |= CRTSCTS;
1365 else
1366 data->term.c_iflag &= ~CRTSCTS;
1367 } else {
1368 /* Asymmetric use of RTS/CTS not supported. */
1369 if (data->term.c_iflag & CRTSCTS) {
1370 /* Flow control can only be disabled for both RTS & CTS together. */
1371 if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) {
1372 if (config->cts != SP_CTS_IGNORE)
1373 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
1374 }
1375 if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) {
1376 if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL)
1377 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
1378 }
1379 } else {
1380 /* Flow control can only be enabled for both RTS & CTS together. */
1381 if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) ||
1382 ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL)))
1383 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be enabled together");
1384 }
1385
1386 if (config->rts >= 0) {
1387 if (config->rts == SP_RTS_FLOW_CONTROL) {
1388 data->term.c_iflag |= CRTSCTS;
1389 } else {
1390 controlbits = TIOCM_RTS;
1391 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
1392 &controlbits) < 0)
1393 RETURN_FAIL("Setting RTS signal level failed");
1394 }
1395 }
1396 }
1397 }
1398
1399 if (config->dtr >= 0 || config->dsr >= 0) {
1400 if (data->termiox_supported) {
1401 data->flow &= ~(DTR_FLOW | DSR_FLOW);
1402 switch (config->dtr) {
1403 case SP_DTR_OFF:
1404 case SP_DTR_ON:
1405 controlbits = TIOCM_DTR;
1406 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
1407 RETURN_FAIL("Setting DTR signal level failed");
1408 break;
1409 case SP_DTR_FLOW_CONTROL:
1410 data->flow |= DTR_FLOW;
1411 break;
1412 default:
1413 break;
1414 }
1415 if (config->dsr == SP_DSR_FLOW_CONTROL)
1416 data->flow |= DSR_FLOW;
1417 } else {
1418 /* DTR/DSR flow control not supported. */
1419 if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
1420 RETURN_ERROR(SP_ERR_SUPP, "DTR/DSR flow control not supported");
1421
1422 if (config->dtr >= 0) {
1423 controlbits = TIOCM_DTR;
1424 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
1425 &controlbits) < 0)
1426 RETURN_FAIL("Setting DTR signal level failed");
1427 }
1428 }
1429 }
1430
1431 if (config->xon_xoff >= 0) {
1432 data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
1433 switch (config->xon_xoff) {
1434 case SP_XONXOFF_DISABLED:
1435 break;
1436 case SP_XONXOFF_IN:
1437 data->term.c_iflag |= IXOFF;
1438 break;
1439 case SP_XONXOFF_OUT:
1440 data->term.c_iflag |= IXON | IXANY;
1441 break;
1442 case SP_XONXOFF_INOUT:
1443 data->term.c_iflag |= IXON | IXOFF | IXANY;
1444 break;
1445 default:
1446 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
1447 }
1448 }
1449
1450 if (tcsetattr(port->fd, TCSADRAIN, &data->term) < 0)
1451 RETURN_FAIL("tcsetattr() failed");
1452
1453#ifdef __APPLE__
1454 if (baud_nonstd != B0) {
1455 if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1)
1456 RETURN_FAIL("IOSSIOSPEED ioctl failed");
1457 /* Set baud rates in data->term to correct, but incompatible
1458 * with tcsetattr() value, same as delivered by tcgetattr(). */
1459 if (cfsetspeed(&data->term, baud_nonstd) < 0)
1460 RETURN_FAIL("cfsetspeed() failed");
1461 }
1462#elif defined(__linux__)
1463 if (baud_nonstd)
1464 TRY(set_baudrate(port->fd, config->baudrate));
1465#ifdef USE_TERMIOX
1466 if (data->termiox_supported)
1467 TRY(set_flow(port->fd, data->flow));
1468#endif
1469#endif
1470
1471#endif /* !_WIN32 */
1472
1473 RETURN_OK();
1474}
1475
1476enum sp_return sp_new_config(struct sp_port_config **config_ptr)
1477{
1478 TRACE("%p", config_ptr);
1479 struct sp_port_config *config;
1480
1481 if (!config_ptr)
1482 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
1483
1484 *config_ptr = NULL;
1485
1486 if (!(config = malloc(sizeof(struct sp_port_config))))
1487 RETURN_ERROR(SP_ERR_MEM, "config malloc failed");
1488
1489 config->baudrate = -1;
1490 config->bits = -1;
1491 config->parity = -1;
1492 config->stopbits = -1;
1493 config->rts = -1;
1494 config->cts = -1;
1495 config->dtr = -1;
1496 config->dsr = -1;
1497
1498 *config_ptr = config;
1499
1500 RETURN_OK();
1501}
1502
1503void sp_free_config(struct sp_port_config *config)
1504{
1505 TRACE("%p", config);
1506
1507 if (!config)
1508 DEBUG("Null config");
1509 else
1510 free(config);
1511
1512 RETURN();
1513}
1514
1515enum sp_return sp_get_config(struct sp_port *port, struct sp_port_config *config)
1516{
1517 struct port_data data;
1518
1519 TRACE("%p, %p", port, config);
1520
1521 CHECK_OPEN_PORT();
1522
1523 if (!config)
1524 RETURN_ERROR(SP_ERR_ARG, "Null config");
1525
1526 TRY(get_config(port, &data, config));
1527
1528 RETURN_OK();
1529}
1530
1531enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *config)
1532{
1533 struct port_data data;
1534 struct sp_port_config prev_config;
1535
1536 TRACE("%p, %p", port, config);
1537
1538 CHECK_OPEN_PORT();
1539
1540 if (!config)
1541 RETURN_ERROR(SP_ERR_ARG, "Null config");
1542
1543 TRY(get_config(port, &data, &prev_config));
1544 TRY(set_config(port, &data, config));
1545
1546 RETURN_OK();
1547}
1548
1549#define CREATE_ACCESSORS(x, type) \
1550enum sp_return sp_set_##x(struct sp_port *port, type x) { \
1551 struct port_data data; \
1552 struct sp_port_config config; \
1553 TRACE("%p, %d", port, x); \
1554 CHECK_OPEN_PORT(); \
1555 TRY(get_config(port, &data, &config)); \
1556 config.x = x; \
1557 TRY(set_config(port, &data, &config)); \
1558 RETURN_OK(); \
1559} \
1560enum sp_return sp_get_config_##x(const struct sp_port_config *config, type *x) { \
1561 TRACE("%p", config); \
1562 if (!config) \
1563 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
1564 *x = config->x; \
1565 RETURN_OK(); \
1566} \
1567enum sp_return sp_set_config_##x(struct sp_port_config *config, type x) { \
1568 TRACE("%p, %d", config, x); \
1569 if (!config) \
1570 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
1571 config->x = x; \
1572 RETURN_OK(); \
1573}
1574
1575CREATE_ACCESSORS(baudrate, int)
1576CREATE_ACCESSORS(bits, int)
1577CREATE_ACCESSORS(parity, enum sp_parity)
1578CREATE_ACCESSORS(stopbits, int)
1579CREATE_ACCESSORS(rts, enum sp_rts)
1580CREATE_ACCESSORS(cts, enum sp_cts)
1581CREATE_ACCESSORS(dtr, enum sp_dtr)
1582CREATE_ACCESSORS(dsr, enum sp_dsr)
1583CREATE_ACCESSORS(xon_xoff, enum sp_xonxoff)
1584
1585enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config, enum sp_flowcontrol flowcontrol)
1586{
1587 if (!config)
1588 RETURN_ERROR(SP_ERR_ARG, "Null configuration");
1589
1590 if (flowcontrol > SP_FLOWCONTROL_DTRDSR)
1591 RETURN_ERROR(SP_ERR_ARG, "Invalid flow control setting");
1592
1593 if (flowcontrol == SP_FLOWCONTROL_XONXOFF)
1594 config->xon_xoff = SP_XONXOFF_INOUT;
1595 else
1596 config->xon_xoff = SP_XONXOFF_DISABLED;
1597
1598 if (flowcontrol == SP_FLOWCONTROL_RTSCTS) {
1599 config->rts = SP_RTS_FLOW_CONTROL;
1600 config->cts = SP_CTS_FLOW_CONTROL;
1601 } else {
1602 if (config->rts == SP_RTS_FLOW_CONTROL)
1603 config->rts = SP_RTS_ON;
1604 config->cts = SP_CTS_IGNORE;
1605 }
1606
1607 if (flowcontrol == SP_FLOWCONTROL_DTRDSR) {
1608 config->dtr = SP_DTR_FLOW_CONTROL;
1609 config->dsr = SP_DSR_FLOW_CONTROL;
1610 } else {
1611 if (config->dtr == SP_DTR_FLOW_CONTROL)
1612 config->dtr = SP_DTR_ON;
1613 config->dsr = SP_DSR_IGNORE;
1614 }
1615
1616 RETURN_OK();
1617}
1618
1619enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol)
1620{
1621 struct port_data data;
1622 struct sp_port_config config;
1623
1624 TRACE("%p, %d", port, flowcontrol);
1625
1626 CHECK_OPEN_PORT();
1627
1628 TRY(get_config(port, &data, &config));
1629
1630 TRY(sp_set_config_flowcontrol(&config, flowcontrol));
1631
1632 TRY(set_config(port, &data, &config));
1633
1634 RETURN_OK();
1635}
1636
1637enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals)
1638{
1639 TRACE("%p, %p", port, signals);
1640
1641 CHECK_OPEN_PORT();
1642
1643 if (!signals)
1644 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
1645
1646 DEBUG("Getting control signals for port %s", port->name);
1647
1648 *signals = 0;
1649#ifdef _WIN32
1650 DWORD bits;
1651 if (GetCommModemStatus(port->hdl, &bits) == 0)
1652 RETURN_FAIL("GetCommModemStatus() failed");
1653 if (bits & MS_CTS_ON)
1654 *signals |= SP_SIG_CTS;
1655 if (bits & MS_DSR_ON)
1656 *signals |= SP_SIG_DSR;
1657 if (bits & MS_RLSD_ON)
1658 *signals |= SP_SIG_DCD;
1659 if (bits & MS_RING_ON)
1660 *signals |= SP_SIG_RI;
1661#else
1662 int bits;
1663 if (ioctl(port->fd, TIOCMGET, &bits) < 0)
1664 RETURN_FAIL("TIOCMGET ioctl failed");
1665 if (bits & TIOCM_CTS)
1666 *signals |= SP_SIG_CTS;
1667 if (bits & TIOCM_DSR)
1668 *signals |= SP_SIG_DSR;
1669 if (bits & TIOCM_CAR)
1670 *signals |= SP_SIG_DCD;
1671 if (bits & TIOCM_RNG)
1672 *signals |= SP_SIG_RI;
1673#endif
1674 RETURN_OK();
1675}
1676
1677enum sp_return sp_start_break(struct sp_port *port)
1678{
1679 TRACE("%p", port);
1680
1681 CHECK_OPEN_PORT();
1682#ifdef _WIN32
1683 if (SetCommBreak(port->hdl) == 0)
1684 RETURN_FAIL("SetCommBreak() failed");
1685#else
1686 if (ioctl(port->fd, TIOCSBRK, 1) < 0)
1687 RETURN_FAIL("TIOCSBRK ioctl failed");
1688#endif
1689
1690 RETURN_OK();
1691}
1692
1693enum sp_return sp_end_break(struct sp_port *port)
1694{
1695 TRACE("%p", port);
1696
1697 CHECK_OPEN_PORT();
1698#ifdef _WIN32
1699 if (ClearCommBreak(port->hdl) == 0)
1700 RETURN_FAIL("ClearCommBreak() failed");
1701#else
1702 if (ioctl(port->fd, TIOCCBRK, 1) < 0)
1703 RETURN_FAIL("TIOCCBRK ioctl failed");
1704#endif
1705
1706 RETURN_OK();
1707}
1708
1709int sp_last_error_code(void)
1710{
1711 TRACE("");
1712#ifdef _WIN32
1713 RETURN_VALUE("%d", GetLastError());
1714#else
1715 RETURN_VALUE("%d", errno);
1716#endif
1717}
1718
1719char *sp_last_error_message(void)
1720{
1721 TRACE("");
1722
1723#ifdef _WIN32
1724 LPVOID message;
1725 DWORD error = GetLastError();
1726
1727 FormatMessage(
1728 FORMAT_MESSAGE_ALLOCATE_BUFFER |
1729 FORMAT_MESSAGE_FROM_SYSTEM |
1730 FORMAT_MESSAGE_IGNORE_INSERTS,
1731 NULL,
1732 error,
1733 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
1734 (LPTSTR) &message,
1735 0, NULL );
1736
1737 RETURN_VALUE("%s", message);
1738#else
1739 RETURN_VALUE("%s", strerror(errno));
1740#endif
1741}
1742
1743void sp_free_error_message(char *message)
1744{
1745 TRACE("%s", message);
1746
1747#ifdef _WIN32
1748 LocalFree(message);
1749#else
1750 (void)message;
1751#endif
1752
1753 RETURN();
1754}
1755
1756void sp_set_debug_handler(void (*handler)(const char *format, ...))
1757{
1758 TRACE("%p", handler);
1759
1760 sp_debug_handler = handler;
1761
1762 RETURN();
1763}
1764
1765void sp_default_debug_handler(const char *format, ...)
1766{
1767 va_list args;
1768 va_start(args, format);
1769 if (getenv("LIBSERIALPORT_DEBUG")) {
1770 fputs("libserialport: ", stderr);
1771 vfprintf(stderr, format, args);
1772 }
1773 va_end(args);
1774}