]> 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
Support mark/space parity settings.
[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 ODDPARITY:
1028 config->parity = SP_PARITY_ODD;
1029 break;
1030 case EVENPARITY:
1031 config->parity = SP_PARITY_EVEN;
1032 break;
1033 case MARKPARITY:
1034 config->parity = SP_PARITY_MARK;
1035 break;
1036 case SPACEPARITY:
1037 config->parity = SP_PARITY_SPACE;
1038 break;
1039 default:
1040 config->parity = -1;
1041 }
1042 else
1043 config->parity = SP_PARITY_NONE;
1044
1045 switch (data->dcb.StopBits) {
1046 case ONESTOPBIT:
1047 config->stopbits = 1;
1048 break;
1049 case TWOSTOPBITS:
1050 config->stopbits = 2;
1051 break;
1052 default:
1053 config->stopbits = -1;
1054 }
1055
1056 switch (data->dcb.fRtsControl) {
1057 case RTS_CONTROL_DISABLE:
1058 config->rts = SP_RTS_OFF;
1059 break;
1060 case RTS_CONTROL_ENABLE:
1061 config->rts = SP_RTS_ON;
1062 break;
1063 case RTS_CONTROL_HANDSHAKE:
1064 config->rts = SP_RTS_FLOW_CONTROL;
1065 break;
1066 default:
1067 config->rts = -1;
1068 }
1069
1070 config->cts = data->dcb.fOutxCtsFlow ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1071
1072 switch (data->dcb.fDtrControl) {
1073 case DTR_CONTROL_DISABLE:
1074 config->dtr = SP_DTR_OFF;
1075 break;
1076 case DTR_CONTROL_ENABLE:
1077 config->dtr = SP_DTR_ON;
1078 break;
1079 case DTR_CONTROL_HANDSHAKE:
1080 config->dtr = SP_DTR_FLOW_CONTROL;
1081 break;
1082 default:
1083 config->dtr = -1;
1084 }
1085
1086 config->dsr = data->dcb.fOutxDsrFlow ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1087
1088 if (data->dcb.fInX) {
1089 if (data->dcb.fOutX)
1090 config->xon_xoff = SP_XONXOFF_INOUT;
1091 else
1092 config->xon_xoff = SP_XONXOFF_IN;
1093 } else {
1094 if (data->dcb.fOutX)
1095 config->xon_xoff = SP_XONXOFF_OUT;
1096 else
1097 config->xon_xoff = SP_XONXOFF_DISABLED;
1098 }
1099
1100#else // !_WIN32
1101
1102 if (tcgetattr(port->fd, &data->term) < 0)
1103 RETURN_FAIL("tcgetattr() failed");
1104
1105 if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0)
1106 RETURN_FAIL("TIOCMGET ioctl failed");
1107
1108#ifdef USE_TERMIOX
1109 int ret = get_flow(port->fd, &data->flow);
1110
1111 if (ret == SP_ERR_FAIL && errno == EINVAL)
1112 data->termiox_supported = 0;
1113 else if (ret < 0)
1114 RETURN_CODEVAL(ret);
1115 else
1116 data->termiox_supported = 1;
1117#else
1118 data->termiox_supported = 0;
1119#endif
1120
1121 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1122 if (cfgetispeed(&data->term) == std_baudrates[i].index) {
1123 config->baudrate = std_baudrates[i].value;
1124 break;
1125 }
1126 }
1127
1128 if (i == NUM_STD_BAUDRATES) {
1129#ifdef __APPLE__
1130 config->baudrate = (int)data->term.c_ispeed;
1131#elif defined(__linux__)
1132 TRY(get_baudrate(port->fd, &config->baudrate));
1133#else
1134 config->baudrate = -1;
1135#endif
1136 }
1137
1138 switch (data->term.c_cflag & CSIZE) {
1139 case CS8:
1140 config->bits = 8;
1141 break;
1142 case CS7:
1143 config->bits = 7;
1144 break;
1145 case CS6:
1146 config->bits = 6;
1147 break;
1148 case CS5:
1149 config->bits = 5;
1150 break;
1151 default:
1152 config->bits = -1;
1153 }
1154
1155 if (!(data->term.c_cflag & PARENB) && (data->term.c_iflag & IGNPAR))
1156 config->parity = SP_PARITY_NONE;
1157 else if (!(data->term.c_cflag & PARENB) || (data->term.c_iflag & IGNPAR))
1158 config->parity = -1;
1159 else if (data->term.c_cflag & CMSPAR)
1160 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_MARK : SP_PARITY_SPACE;
1161 else
1162 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_ODD : SP_PARITY_EVEN;
1163
1164 config->stopbits = (data->term.c_cflag & CSTOPB) ? 2 : 1;
1165
1166 if (data->term.c_cflag & CRTSCTS) {
1167 config->rts = SP_RTS_FLOW_CONTROL;
1168 config->cts = SP_CTS_FLOW_CONTROL;
1169 } else {
1170 if (data->termiox_supported && data->flow & RTS_FLOW)
1171 config->rts = SP_RTS_FLOW_CONTROL;
1172 else
1173 config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
1174
1175 config->cts = (data->termiox_supported && data->flow & CTS_FLOW) ?
1176 SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1177 }
1178
1179 if (data->termiox_supported && data->flow & DTR_FLOW)
1180 config->dtr = SP_DTR_FLOW_CONTROL;
1181 else
1182 config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
1183
1184 config->dsr = (data->termiox_supported && data->flow & DSR_FLOW) ?
1185 SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1186
1187 if (data->term.c_iflag & IXOFF) {
1188 if (data->term.c_iflag & IXON)
1189 config->xon_xoff = SP_XONXOFF_INOUT;
1190 else
1191 config->xon_xoff = SP_XONXOFF_IN;
1192 } else {
1193 if (data->term.c_iflag & IXON)
1194 config->xon_xoff = SP_XONXOFF_OUT;
1195 else
1196 config->xon_xoff = SP_XONXOFF_DISABLED;
1197 }
1198#endif
1199
1200 RETURN_OK();
1201}
1202
1203static enum sp_return set_config(struct sp_port *port, struct port_data *data,
1204 const struct sp_port_config *config)
1205{
1206 unsigned int i;
1207#ifdef __APPLE__
1208 BAUD_TYPE baud_nonstd;
1209
1210 baud_nonstd = B0;
1211#endif
1212#ifdef __linux__
1213 int baud_nonstd = 0;
1214#endif
1215
1216 TRACE("%p, %p, %p", port, data, config);
1217
1218 DEBUG("Setting configuration for port %s", port->name);
1219
1220#ifdef _WIN32
1221 if (config->baudrate >= 0) {
1222 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1223 if (config->baudrate == std_baudrates[i].value) {
1224 data->dcb.BaudRate = std_baudrates[i].index;
1225 break;
1226 }
1227 }
1228
1229 if (i == NUM_STD_BAUDRATES)
1230 data->dcb.BaudRate = config->baudrate;
1231 }
1232
1233 if (config->bits >= 0)
1234 data->dcb.ByteSize = config->bits;
1235
1236 if (config->parity >= 0) {
1237 switch (config->parity) {
1238 /* Note: There's also SPACEPARITY, MARKPARITY (unneeded so far). */
1239 case SP_PARITY_NONE:
1240 data->dcb.Parity = NOPARITY;
1241 break;
1242 case SP_PARITY_ODD:
1243 data->dcb.Parity = ODDPARITY;
1244 break;
1245 case SP_PARITY_EVEN:
1246 data->dcb.Parity = EVENPARITY;
1247 break;
1248 case SP_PARITY_MARK:
1249 data->dcb.Parity = MARKPARITY;
1250 break;
1251 case SP_PARITY_SPACE:
1252 data->dcb.Parity = SPACEPARITY;
1253 break;
1254 default:
1255 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1256 }
1257 }
1258
1259 if (config->stopbits >= 0) {
1260 switch (config->stopbits) {
1261 /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
1262 case 1:
1263 data->dcb.StopBits = ONESTOPBIT;
1264 break;
1265 case 2:
1266 data->dcb.StopBits = TWOSTOPBITS;
1267 break;
1268 default:
1269 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bit setting");
1270 }
1271 }
1272
1273 if (config->rts >= 0) {
1274 switch (config->rts) {
1275 case SP_RTS_OFF:
1276 data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
1277 break;
1278 case SP_RTS_ON:
1279 data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
1280 break;
1281 case SP_RTS_FLOW_CONTROL:
1282 data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
1283 break;
1284 default:
1285 RETURN_ERROR(SP_ERR_ARG, "Invalid RTS setting");
1286 }
1287 }
1288
1289 if (config->cts >= 0) {
1290 switch (config->cts) {
1291 case SP_CTS_IGNORE:
1292 data->dcb.fOutxCtsFlow = FALSE;
1293 break;
1294 case SP_CTS_FLOW_CONTROL:
1295 data->dcb.fOutxCtsFlow = TRUE;
1296 break;
1297 default:
1298 RETURN_ERROR(SP_ERR_ARG, "Invalid CTS setting");
1299 }
1300 }
1301
1302 if (config->dtr >= 0) {
1303 switch (config->dtr) {
1304 case SP_DTR_OFF:
1305 data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
1306 break;
1307 case SP_DTR_ON:
1308 data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
1309 break;
1310 case SP_DTR_FLOW_CONTROL:
1311 data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
1312 break;
1313 default:
1314 RETURN_ERROR(SP_ERR_ARG, "Invalid DTR setting");
1315 }
1316 }
1317
1318 if (config->dsr >= 0) {
1319 switch (config->dsr) {
1320 case SP_DSR_IGNORE:
1321 data->dcb.fOutxDsrFlow = FALSE;
1322 break;
1323 case SP_DSR_FLOW_CONTROL:
1324 data->dcb.fOutxDsrFlow = TRUE;
1325 break;
1326 default:
1327 RETURN_ERROR(SP_ERR_ARG, "Invalid DSR setting");
1328 }
1329 }
1330
1331 if (config->xon_xoff >= 0) {
1332 switch (config->xon_xoff) {
1333 case SP_XONXOFF_DISABLED:
1334 data->dcb.fInX = FALSE;
1335 data->dcb.fOutX = FALSE;
1336 break;
1337 case SP_XONXOFF_IN:
1338 data->dcb.fInX = TRUE;
1339 data->dcb.fOutX = FALSE;
1340 break;
1341 case SP_XONXOFF_OUT:
1342 data->dcb.fInX = FALSE;
1343 data->dcb.fOutX = TRUE;
1344 break;
1345 case SP_XONXOFF_INOUT:
1346 data->dcb.fInX = TRUE;
1347 data->dcb.fOutX = TRUE;
1348 break;
1349 default:
1350 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
1351 }
1352 }
1353
1354 if (!SetCommState(port->hdl, &data->dcb))
1355 RETURN_FAIL("SetCommState() failed");
1356
1357#else /* !_WIN32 */
1358
1359 int controlbits;
1360
1361 if (config->baudrate >= 0) {
1362 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1363 if (config->baudrate == std_baudrates[i].value) {
1364 if (cfsetospeed(&data->term, std_baudrates[i].index) < 0)
1365 RETURN_FAIL("cfsetospeed() failed");
1366
1367 if (cfsetispeed(&data->term, std_baudrates[i].index) < 0)
1368 RETURN_FAIL("cfsetispeed() failed");
1369 break;
1370 }
1371 }
1372
1373 /* Non-standard baud rate */
1374 if (i == NUM_STD_BAUDRATES) {
1375#ifdef __APPLE__
1376 /* Set "dummy" baud rate. */
1377 if (cfsetspeed(&data->term, B9600) < 0)
1378 RETURN_FAIL("cfsetspeed() failed");
1379 baud_nonstd = config->baudrate;
1380#elif defined(__linux__)
1381 baud_nonstd = 1;
1382#else
1383 RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported");
1384#endif
1385 }
1386 }
1387
1388 if (config->bits >= 0) {
1389 data->term.c_cflag &= ~CSIZE;
1390 switch (config->bits) {
1391 case 8:
1392 data->term.c_cflag |= CS8;
1393 break;
1394 case 7:
1395 data->term.c_cflag |= CS7;
1396 break;
1397 case 6:
1398 data->term.c_cflag |= CS6;
1399 break;
1400 case 5:
1401 data->term.c_cflag |= CS5;
1402 break;
1403 default:
1404 RETURN_ERROR(SP_ERR_ARG, "Invalid data bits setting");
1405 }
1406 }
1407
1408 if (config->parity >= 0) {
1409 data->term.c_iflag &= ~IGNPAR;
1410 data->term.c_cflag &= ~(PARENB | PARODD | CMSPAR);
1411 switch (config->parity) {
1412 case SP_PARITY_NONE:
1413 data->term.c_iflag |= IGNPAR;
1414 break;
1415 case SP_PARITY_EVEN:
1416 data->term.c_cflag |= PARENB;
1417 break;
1418 case SP_PARITY_ODD:
1419 data->term.c_cflag |= PARENB | PARODD;
1420 break;
1421 case SP_PARITY_MARK:
1422 data->term.c_cflag |= PARENB | PARODD | CMSPAR;
1423 break;
1424 case SP_PARITY_SPACE:
1425 data->term.c_cflag |= PARENB | CMSPAR;
1426 break;
1427 default:
1428 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1429 }
1430 }
1431
1432 if (config->stopbits >= 0) {
1433 data->term.c_cflag &= ~CSTOPB;
1434 switch (config->stopbits) {
1435 case 1:
1436 data->term.c_cflag &= ~CSTOPB;
1437 break;
1438 case 2:
1439 data->term.c_cflag |= CSTOPB;
1440 break;
1441 default:
1442 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bits setting");
1443 }
1444 }
1445
1446 if (config->rts >= 0 || config->cts >= 0) {
1447 if (data->termiox_supported) {
1448 data->flow &= ~(RTS_FLOW | CTS_FLOW);
1449 switch (config->rts) {
1450 case SP_RTS_OFF:
1451 case SP_RTS_ON:
1452 controlbits = TIOCM_RTS;
1453 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
1454 RETURN_FAIL("Setting RTS signal level failed");
1455 break;
1456 case SP_RTS_FLOW_CONTROL:
1457 data->flow |= RTS_FLOW;
1458 break;
1459 default:
1460 break;
1461 }
1462 if (config->cts == SP_CTS_FLOW_CONTROL)
1463 data->flow |= CTS_FLOW;
1464
1465 if (data->flow & (RTS_FLOW | CTS_FLOW))
1466 data->term.c_iflag |= CRTSCTS;
1467 else
1468 data->term.c_iflag &= ~CRTSCTS;
1469 } else {
1470 /* Asymmetric use of RTS/CTS not supported. */
1471 if (data->term.c_iflag & CRTSCTS) {
1472 /* Flow control can only be disabled for both RTS & CTS together. */
1473 if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) {
1474 if (config->cts != SP_CTS_IGNORE)
1475 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
1476 }
1477 if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) {
1478 if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL)
1479 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
1480 }
1481 } else {
1482 /* Flow control can only be enabled for both RTS & CTS together. */
1483 if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) ||
1484 ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL)))
1485 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be enabled together");
1486 }
1487
1488 if (config->rts >= 0) {
1489 if (config->rts == SP_RTS_FLOW_CONTROL) {
1490 data->term.c_iflag |= CRTSCTS;
1491 } else {
1492 controlbits = TIOCM_RTS;
1493 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
1494 &controlbits) < 0)
1495 RETURN_FAIL("Setting RTS signal level failed");
1496 }
1497 }
1498 }
1499 }
1500
1501 if (config->dtr >= 0 || config->dsr >= 0) {
1502 if (data->termiox_supported) {
1503 data->flow &= ~(DTR_FLOW | DSR_FLOW);
1504 switch (config->dtr) {
1505 case SP_DTR_OFF:
1506 case SP_DTR_ON:
1507 controlbits = TIOCM_DTR;
1508 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
1509 RETURN_FAIL("Setting DTR signal level failed");
1510 break;
1511 case SP_DTR_FLOW_CONTROL:
1512 data->flow |= DTR_FLOW;
1513 break;
1514 default:
1515 break;
1516 }
1517 if (config->dsr == SP_DSR_FLOW_CONTROL)
1518 data->flow |= DSR_FLOW;
1519 } else {
1520 /* DTR/DSR flow control not supported. */
1521 if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
1522 RETURN_ERROR(SP_ERR_SUPP, "DTR/DSR flow control not supported");
1523
1524 if (config->dtr >= 0) {
1525 controlbits = TIOCM_DTR;
1526 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
1527 &controlbits) < 0)
1528 RETURN_FAIL("Setting DTR signal level failed");
1529 }
1530 }
1531 }
1532
1533 if (config->xon_xoff >= 0) {
1534 data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
1535 switch (config->xon_xoff) {
1536 case SP_XONXOFF_DISABLED:
1537 break;
1538 case SP_XONXOFF_IN:
1539 data->term.c_iflag |= IXOFF;
1540 break;
1541 case SP_XONXOFF_OUT:
1542 data->term.c_iflag |= IXON | IXANY;
1543 break;
1544 case SP_XONXOFF_INOUT:
1545 data->term.c_iflag |= IXON | IXOFF | IXANY;
1546 break;
1547 default:
1548 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
1549 }
1550 }
1551
1552 if (tcsetattr(port->fd, TCSADRAIN, &data->term) < 0)
1553 RETURN_FAIL("tcsetattr() failed");
1554
1555#ifdef __APPLE__
1556 if (baud_nonstd != B0) {
1557 if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1)
1558 RETURN_FAIL("IOSSIOSPEED ioctl failed");
1559 /* Set baud rates in data->term to correct, but incompatible
1560 * with tcsetattr() value, same as delivered by tcgetattr(). */
1561 if (cfsetspeed(&data->term, baud_nonstd) < 0)
1562 RETURN_FAIL("cfsetspeed() failed");
1563 }
1564#elif defined(__linux__)
1565 if (baud_nonstd)
1566 TRY(set_baudrate(port->fd, config->baudrate));
1567#ifdef USE_TERMIOX
1568 if (data->termiox_supported)
1569 TRY(set_flow(port->fd, data->flow));
1570#endif
1571#endif
1572
1573#endif /* !_WIN32 */
1574
1575 RETURN_OK();
1576}
1577
1578enum sp_return sp_new_config(struct sp_port_config **config_ptr)
1579{
1580 TRACE("%p", config_ptr);
1581 struct sp_port_config *config;
1582
1583 if (!config_ptr)
1584 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
1585
1586 *config_ptr = NULL;
1587
1588 if (!(config = malloc(sizeof(struct sp_port_config))))
1589 RETURN_ERROR(SP_ERR_MEM, "config malloc failed");
1590
1591 config->baudrate = -1;
1592 config->bits = -1;
1593 config->parity = -1;
1594 config->stopbits = -1;
1595 config->rts = -1;
1596 config->cts = -1;
1597 config->dtr = -1;
1598 config->dsr = -1;
1599
1600 *config_ptr = config;
1601
1602 RETURN_OK();
1603}
1604
1605void sp_free_config(struct sp_port_config *config)
1606{
1607 TRACE("%p", config);
1608
1609 if (!config)
1610 DEBUG("Null config");
1611 else
1612 free(config);
1613
1614 RETURN();
1615}
1616
1617enum sp_return sp_get_config(struct sp_port *port, struct sp_port_config *config)
1618{
1619 struct port_data data;
1620
1621 TRACE("%p, %p", port, config);
1622
1623 CHECK_OPEN_PORT();
1624
1625 if (!config)
1626 RETURN_ERROR(SP_ERR_ARG, "Null config");
1627
1628 TRY(get_config(port, &data, config));
1629
1630 RETURN_OK();
1631}
1632
1633enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *config)
1634{
1635 struct port_data data;
1636 struct sp_port_config prev_config;
1637
1638 TRACE("%p, %p", port, config);
1639
1640 CHECK_OPEN_PORT();
1641
1642 if (!config)
1643 RETURN_ERROR(SP_ERR_ARG, "Null config");
1644
1645 TRY(get_config(port, &data, &prev_config));
1646 TRY(set_config(port, &data, config));
1647
1648 RETURN_OK();
1649}
1650
1651#define CREATE_ACCESSORS(x, type) \
1652enum sp_return sp_set_##x(struct sp_port *port, type x) { \
1653 struct port_data data; \
1654 struct sp_port_config config; \
1655 TRACE("%p, %d", port, x); \
1656 CHECK_OPEN_PORT(); \
1657 TRY(get_config(port, &data, &config)); \
1658 config.x = x; \
1659 TRY(set_config(port, &data, &config)); \
1660 RETURN_OK(); \
1661} \
1662enum sp_return sp_get_config_##x(const struct sp_port_config *config, type *x) { \
1663 TRACE("%p", config); \
1664 if (!config) \
1665 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
1666 *x = config->x; \
1667 RETURN_OK(); \
1668} \
1669enum sp_return sp_set_config_##x(struct sp_port_config *config, type x) { \
1670 TRACE("%p, %d", config, x); \
1671 if (!config) \
1672 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
1673 config->x = x; \
1674 RETURN_OK(); \
1675}
1676
1677CREATE_ACCESSORS(baudrate, int)
1678CREATE_ACCESSORS(bits, int)
1679CREATE_ACCESSORS(parity, enum sp_parity)
1680CREATE_ACCESSORS(stopbits, int)
1681CREATE_ACCESSORS(rts, enum sp_rts)
1682CREATE_ACCESSORS(cts, enum sp_cts)
1683CREATE_ACCESSORS(dtr, enum sp_dtr)
1684CREATE_ACCESSORS(dsr, enum sp_dsr)
1685CREATE_ACCESSORS(xon_xoff, enum sp_xonxoff)
1686
1687enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config, enum sp_flowcontrol flowcontrol)
1688{
1689 if (!config)
1690 RETURN_ERROR(SP_ERR_ARG, "Null configuration");
1691
1692 if (flowcontrol > SP_FLOWCONTROL_DTRDSR)
1693 RETURN_ERROR(SP_ERR_ARG, "Invalid flow control setting");
1694
1695 if (flowcontrol == SP_FLOWCONTROL_XONXOFF)
1696 config->xon_xoff = SP_XONXOFF_INOUT;
1697 else
1698 config->xon_xoff = SP_XONXOFF_DISABLED;
1699
1700 if (flowcontrol == SP_FLOWCONTROL_RTSCTS) {
1701 config->rts = SP_RTS_FLOW_CONTROL;
1702 config->cts = SP_CTS_FLOW_CONTROL;
1703 } else {
1704 if (config->rts == SP_RTS_FLOW_CONTROL)
1705 config->rts = SP_RTS_ON;
1706 config->cts = SP_CTS_IGNORE;
1707 }
1708
1709 if (flowcontrol == SP_FLOWCONTROL_DTRDSR) {
1710 config->dtr = SP_DTR_FLOW_CONTROL;
1711 config->dsr = SP_DSR_FLOW_CONTROL;
1712 } else {
1713 if (config->dtr == SP_DTR_FLOW_CONTROL)
1714 config->dtr = SP_DTR_ON;
1715 config->dsr = SP_DSR_IGNORE;
1716 }
1717
1718 RETURN_OK();
1719}
1720
1721enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol)
1722{
1723 struct port_data data;
1724 struct sp_port_config config;
1725
1726 TRACE("%p, %d", port, flowcontrol);
1727
1728 CHECK_OPEN_PORT();
1729
1730 TRY(get_config(port, &data, &config));
1731
1732 TRY(sp_set_config_flowcontrol(&config, flowcontrol));
1733
1734 TRY(set_config(port, &data, &config));
1735
1736 RETURN_OK();
1737}
1738
1739enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals)
1740{
1741 TRACE("%p, %p", port, signals);
1742
1743 CHECK_OPEN_PORT();
1744
1745 if (!signals)
1746 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
1747
1748 DEBUG("Getting control signals for port %s", port->name);
1749
1750 *signals = 0;
1751#ifdef _WIN32
1752 DWORD bits;
1753 if (GetCommModemStatus(port->hdl, &bits) == 0)
1754 RETURN_FAIL("GetCommModemStatus() failed");
1755 if (bits & MS_CTS_ON)
1756 *signals |= SP_SIG_CTS;
1757 if (bits & MS_DSR_ON)
1758 *signals |= SP_SIG_DSR;
1759 if (bits & MS_RLSD_ON)
1760 *signals |= SP_SIG_DCD;
1761 if (bits & MS_RING_ON)
1762 *signals |= SP_SIG_RI;
1763#else
1764 int bits;
1765 if (ioctl(port->fd, TIOCMGET, &bits) < 0)
1766 RETURN_FAIL("TIOCMGET ioctl failed");
1767 if (bits & TIOCM_CTS)
1768 *signals |= SP_SIG_CTS;
1769 if (bits & TIOCM_DSR)
1770 *signals |= SP_SIG_DSR;
1771 if (bits & TIOCM_CAR)
1772 *signals |= SP_SIG_DCD;
1773 if (bits & TIOCM_RNG)
1774 *signals |= SP_SIG_RI;
1775#endif
1776 RETURN_OK();
1777}
1778
1779enum sp_return sp_start_break(struct sp_port *port)
1780{
1781 TRACE("%p", port);
1782
1783 CHECK_OPEN_PORT();
1784#ifdef _WIN32
1785 if (SetCommBreak(port->hdl) == 0)
1786 RETURN_FAIL("SetCommBreak() failed");
1787#else
1788 if (ioctl(port->fd, TIOCSBRK, 1) < 0)
1789 RETURN_FAIL("TIOCSBRK ioctl failed");
1790#endif
1791
1792 RETURN_OK();
1793}
1794
1795enum sp_return sp_end_break(struct sp_port *port)
1796{
1797 TRACE("%p", port);
1798
1799 CHECK_OPEN_PORT();
1800#ifdef _WIN32
1801 if (ClearCommBreak(port->hdl) == 0)
1802 RETURN_FAIL("ClearCommBreak() failed");
1803#else
1804 if (ioctl(port->fd, TIOCCBRK, 1) < 0)
1805 RETURN_FAIL("TIOCCBRK ioctl failed");
1806#endif
1807
1808 RETURN_OK();
1809}
1810
1811int sp_last_error_code(void)
1812{
1813 TRACE("");
1814#ifdef _WIN32
1815 RETURN_VALUE("%d", GetLastError());
1816#else
1817 RETURN_VALUE("%d", errno);
1818#endif
1819}
1820
1821char *sp_last_error_message(void)
1822{
1823 TRACE("");
1824
1825#ifdef _WIN32
1826 LPVOID message;
1827 DWORD error = GetLastError();
1828
1829 FormatMessage(
1830 FORMAT_MESSAGE_ALLOCATE_BUFFER |
1831 FORMAT_MESSAGE_FROM_SYSTEM |
1832 FORMAT_MESSAGE_IGNORE_INSERTS,
1833 NULL,
1834 error,
1835 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
1836 (LPTSTR) &message,
1837 0, NULL );
1838
1839 RETURN_VALUE("%s", message);
1840#else
1841 RETURN_VALUE("%s", strerror(errno));
1842#endif
1843}
1844
1845void sp_free_error_message(char *message)
1846{
1847 TRACE("%s", message);
1848
1849#ifdef _WIN32
1850 LocalFree(message);
1851#else
1852 (void)message;
1853#endif
1854
1855 RETURN();
1856}
1857
1858void sp_set_debug_handler(void (*handler)(const char *format, ...))
1859{
1860 TRACE("%p", handler);
1861
1862 sp_debug_handler = handler;
1863
1864 RETURN();
1865}
1866
1867void sp_default_debug_handler(const char *format, ...)
1868{
1869 va_list args;
1870 va_start(args, format);
1871 if (getenv("LIBSERIALPORT_DEBUG")) {
1872 fputs("libserialport: ", stderr);
1873 vfprintf(stderr, format, args);
1874 }
1875 va_end(args);
1876}
Serial port access library