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