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