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