]> sigrok.org Git - libserialport.git/blame - serialport.c
projects / libserialport.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Make RETURN_VALUE macro side effect safe.
[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) {
1003 DEBUG("Asynchronous write started");
1004 port->writing = 1;
1005 RETURN_VALUE("%d", ++written);
a3cb91f5 1006 } else {
e3dcf906
ML		 1007 /* Actual failure of some kind. */
1008 RETURN_FAIL("WriteFile() failed");
a3cb91f5 1009 }
e3dcf906
ML		 1010 } else {
1011 DEBUG("Single byte written immediately.");
1012 written++;
a3cb91f5
ML		 1013 }
1014 }
1015
e3dcf906
ML		 1016 DEBUG("All bytes written immediately.");
1017
c33efc48 1018 RETURN_VALUE("%d", written);
74510d4b
ML		 1019#else
1020 /* Returns the number of bytes written, or -1 upon failure. */
1021 ssize_t written = write(port->fd, buf, count);
f92f1f0c 1022
74510d4b 1023 if (written < 0)
c33efc48 1024 RETURN_FAIL("write() failed");
74510d4b 1025 else
c33efc48 1026 RETURN_VALUE("%d", written);
74510d4b
ML		 1027#endif
1028}
1029
e3dcf906
ML		 1030enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, unsigned int timeout)
1031{
1032 TRACE("%p, %p, %d, %d", port, buf, count, timeout);
1033
1034 CHECK_OPEN_PORT();
1035
1036 if (!buf)
1037 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
1038
1039 if (timeout)
1040 DEBUG("Reading %d bytes from port %s, timeout %d ms", count, port->name, timeout);
1041 else
1042 DEBUG("Reading %d bytes from port %s, no timeout", count, port->name);
1043
1044 if (count == 0)
1045 RETURN_VALUE("0", 0);
1046
1047#ifdef _WIN32
1048 DWORD bytes_read = 0;
1049
1050 /* Set timeout. */
1051 port->timeouts.ReadIntervalTimeout = 0;
1052 port->timeouts.ReadTotalTimeoutConstant = timeout;
1053 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1054 RETURN_FAIL("SetCommTimeouts() failed");
1055
1056 /* Start read. */
1057 if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl) == 0) {
1058 if (GetLastError() == ERROR_IO_PENDING) {
1059 DEBUG("Waiting for read to complete");
1060 GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE);
1061 DEBUG("Read completed, %d/%d bytes read", bytes_read, count);
1062 RETURN_VALUE("%d", bytes_read);
1063 } else {
1064 RETURN_FAIL("ReadFile() failed");
1065 }
1066 } else {
1067 DEBUG("Read completed immediately");
1068 RETURN_VALUE("%d", count);
1069 }
1070#else
1071 size_t bytes_read = 0;
1072 unsigned char *ptr = (unsigned char *) buf;
1073 struct timeval start, delta, now, end = {0, 0};
1074 fd_set fds;
1075 int result;
1076
1077 if (timeout) {
1078 /* Get time at start of operation. */
1079 gettimeofday(&start, NULL);
1080 /* Define duration of timeout. */
1081 delta.tv_sec = timeout / 1000;
1b342042 1082 delta.tv_usec = (timeout % 1000) * 1000;
e3dcf906
ML		 1083 /* Calculate time at which we should give up. */
1084 timeradd(&start, &delta, &end);
1085 }
1086
1087 /* Loop until we have the requested number of bytes. */
1088 while (bytes_read < count)
1089 {
1090 /* Wait until data is available. */
1091 FD_ZERO(&fds);
1092 FD_SET(port->fd, &fds);
1093 if (timeout) {
1094 gettimeofday(&now, NULL);
1095 if (timercmp(&now, &end, >))
1096 /* Timeout has expired. */
1097 RETURN_VALUE("%d", bytes_read);
1098 timersub(&end, &now, &delta);
1099 }
1100 result = select(port->fd + 1, &fds, NULL, NULL, timeout ? &delta : NULL);
63a17c64
ML		 1101 if (result < 0) {
1102 if (errno == EINTR) {
1103 DEBUG("select() call was interrupted, repeating");
1104 continue;
1105 } else {
1106 RETURN_FAIL("select() failed");
1107 }
1108 } else if (result == 0) {
e3dcf906
ML		 1109 DEBUG("read timed out");
1110 RETURN_VALUE("%d", bytes_read);
1111 }
1112
1113 /* Do read. */
1114 result = read(port->fd, ptr, count - bytes_read);
1115
1116 if (result < 0) {
1117 if (errno == EAGAIN)
1118 /* This shouldn't happen because we did a select() first, but handle anyway. */
1119 continue;
1120 else
1121 /* This is an actual failure. */
1122 RETURN_FAIL("read() failed");
1123 }
1124
1125 bytes_read += result;
1126 ptr += result;
1127 }
1128
1129 RETURN_VALUE("%d", bytes_read);
1130#endif
1131}
1132
1133enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count)
74510d4b 1134{
c33efc48
ML		 1135 TRACE("%p, %p, %d", port, buf, count);
1136
dec10e31 1137 CHECK_OPEN_PORT();
74510d4b
ML		 1138
1139 if (!buf)
c33efc48 1140 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
74510d4b 1141
ea667be7
ML		 1142 DEBUG("Reading up to %d bytes from port %s", count, port->name);
1143
74510d4b 1144#ifdef _WIN32
e3dcf906 1145 DWORD bytes_read;
f92f1f0c 1146
e3dcf906
ML		 1147 /* Set timeout. */
1148 port->timeouts.ReadIntervalTimeout = MAXDWORD;
1149 port->timeouts.ReadTotalTimeoutConstant = 0;
1150 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1151 RETURN_FAIL("SetCommTimeouts() failed");
1152
1153 /* Do read. */
1154 if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl) == 0)
c33efc48 1155 RETURN_FAIL("ReadFile() failed");
e3dcf906
ML		 1156
1157 /* Get number of bytes read. */
1158 GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE);
1159
c33efc48 1160 RETURN_VALUE("%d", bytes_read);
74510d4b
ML		 1161#else
1162 ssize_t bytes_read;
f92f1f0c 1163
74510d4b 1164 /* Returns the number of bytes read, or -1 upon failure. */
33d5ff47 1165 if ((bytes_read = read(port->fd, buf, count)) < 0) {
e3dcf906
ML		 1166 if (errno == EAGAIN)
1167 /* No bytes available. */
33d5ff47
ML		 1168 bytes_read = 0;
1169 else
1170 /* This is an actual failure. */
1171 RETURN_FAIL("read() failed");
1172 }
c33efc48 1173 RETURN_VALUE("%d", bytes_read);
74510d4b
ML		 1174#endif
1175}
1176
3353c22f
ML		 1177enum sp_return sp_input_waiting(struct sp_port *port)
1178{
1179 TRACE("%p", port);
1180
1181 CHECK_OPEN_PORT();
1182
1183 DEBUG("Checking input bytes waiting on port %s", port->name);
1184
1185#ifdef _WIN32
1186 DWORD errors;
1187 COMSTAT comstat;
1188
1189 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1190 RETURN_FAIL("ClearComError() failed");
1191 RETURN_VALUE("%d", comstat.cbInQue);
1192#else
1193 int bytes_waiting;
1194 if (ioctl(port->fd, TIOCINQ, &bytes_waiting) < 0)
1195 RETURN_FAIL("TIOCINQ ioctl failed");
1196 RETURN_VALUE("%d", bytes_waiting);
1197#endif
1198}
1199
1200enum sp_return sp_output_waiting(struct sp_port *port)
1201{
1202 TRACE("%p", port);
1203
1204 CHECK_OPEN_PORT();
1205
1206 DEBUG("Checking output bytes waiting on port %s", port->name);
1207
1208#ifdef _WIN32
1209 DWORD errors;
1210 COMSTAT comstat;
1211
1212 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1213 RETURN_FAIL("ClearComError() failed");
1214 RETURN_VALUE("%d", comstat.cbOutQue);
1215#else
1216 int bytes_waiting;
1217 if (ioctl(port->fd, TIOCOUTQ, &bytes_waiting) < 0)
1218 RETURN_FAIL("TIOCOUTQ ioctl failed");
1219 RETURN_VALUE("%d", bytes_waiting);
1220#endif
1221}
1222
7a6d2196
ML		 1223#ifdef __linux__
1224static enum sp_return get_baudrate(int fd, int *baudrate)
1225{
1226 void *data;
1227
c33efc48
ML		 1228 TRACE("%d, %p", fd, baudrate);
1229
ea667be7
ML		 1230 DEBUG("Getting baud rate");
1231
7a6d2196 1232 if (!(data = malloc(get_termios_size())))
c33efc48 1233 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
7a6d2196 1234
8d43110a
ML		 1235 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1236 free(data);
c33efc48 1237 RETURN_FAIL("getting termios failed");
8d43110a 1238 }
7a6d2196
ML		 1239
1240 *baudrate = get_termios_speed(data);
1241
8d43110a
ML		 1242 free(data);
1243
c33efc48 1244 RETURN_OK();
7a6d2196
ML		 1245}
1246
1247static enum sp_return set_baudrate(int fd, int baudrate)
1248{
1249 void *data;
1250
c33efc48
ML		 1251 TRACE("%d, %d", fd, baudrate);
1252
ea667be7
ML		 1253 DEBUG("Getting baud rate");
1254
7a6d2196 1255 if (!(data = malloc(get_termios_size())))
c33efc48 1256 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
7a6d2196 1257
8d43110a
ML		 1258 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1259 free(data);
c33efc48 1260 RETURN_FAIL("getting termios failed");
8d43110a 1261 }
7a6d2196 1262
ea667be7
ML		 1263 DEBUG("Setting baud rate");
1264
7a6d2196
ML		 1265 set_termios_speed(data, baudrate);
1266
8d43110a
ML		 1267 if (ioctl(fd, get_termios_set_ioctl(), data) < 0) {
1268 free(data);
c33efc48 1269 RETURN_FAIL("setting termios failed");
8d43110a
ML		 1270 }
1271
1272 free(data);
7a6d2196 1273
c33efc48 1274 RETURN_OK();
7a6d2196 1275}
40978c2b
ML		 1276
1277#ifdef USE_TERMIOX
1278static enum sp_return get_flow(int fd, int *flow)
1279{
1280 void *data;
1281
c33efc48
ML		 1282 TRACE("%d, %p", fd, flow);
1283
ea667be7
ML		 1284 DEBUG("Getting advanced flow control");
1285
40978c2b 1286 if (!(data = malloc(get_termiox_size())))
c33efc48 1287 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
40978c2b 1288
8d43110a
ML		 1289 if (ioctl(fd, TCGETX, data) < 0) {
1290 free(data);
c33efc48 1291 RETURN_FAIL("getting termiox failed");
8d43110a 1292 }
40978c2b
ML		 1293
1294 *flow = get_termiox_flow(data);
1295
8d43110a
ML		 1296 free(data);
1297
c33efc48 1298 RETURN_OK();
40978c2b
ML		 1299}
1300
1301static enum sp_return set_flow(int fd, int flow)
1302{
1303 void *data;
1304
c33efc48
ML		 1305 TRACE("%d, %d", fd, flow);
1306
ea667be7
ML		 1307 DEBUG("Getting advanced flow control");
1308
40978c2b 1309 if (!(data = malloc(get_termiox_size())))
c33efc48 1310 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
40978c2b 1311
8d43110a
ML		 1312 if (ioctl(fd, TCGETX, data) < 0) {
1313 free(data);
c33efc48 1314 RETURN_FAIL("getting termiox failed");
8d43110a 1315 }
40978c2b 1316
ea667be7
ML		 1317 DEBUG("Setting advanced flow control");
1318
40978c2b
ML		 1319 set_termiox_flow(data, flow);
1320
8d43110a
ML		 1321 if (ioctl(fd, TCSETX, data) < 0) {
1322 free(data);
c33efc48 1323 RETURN_FAIL("setting termiox failed");
8d43110a
ML		 1324 }
1325
1326 free(data);
40978c2b 1327
c33efc48 1328 RETURN_OK();
40978c2b
ML		 1329}
1330#endif /* USE_TERMIOX */
1331#endif /* __linux__ */
7a6d2196 1332
eb6ed20f
ML		 1333static enum sp_return get_config(struct sp_port *port, struct port_data *data,
1334 struct sp_port_config *config)
8094e4a0 1335{
da2748bf 1336 unsigned int i;
cbf628c7 1337
c33efc48
ML		 1338 TRACE("%p, %p, %p", port, data, config);
1339
ea667be7
ML		 1340 DEBUG("Getting configuration for port %s", port->name);
1341
8094e4a0 1342#ifdef _WIN32
e33ab9aa 1343 if (!GetCommState(port->hdl, &data->dcb))
c33efc48 1344 RETURN_FAIL("GetCommState() failed");
8094e4a0 1345
067417af 1346 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
e33ab9aa 1347 if (data->dcb.BaudRate == std_baudrates[i].index) {
067417af
ML		 1348 config->baudrate = std_baudrates[i].value;
1349 break;
1350 }
1351 }
1352
1353 if (i == NUM_STD_BAUDRATES)
1354 /* BaudRate field can be either an index or a custom baud rate. */
e33ab9aa 1355 config->baudrate = data->dcb.BaudRate;
067417af 1356
e33ab9aa 1357 config->bits = data->dcb.ByteSize;
067417af 1358
e33ab9aa
ML		 1359 if (data->dcb.fParity)
1360 switch (data->dcb.Parity) {
067417af
ML		 1361 case NOPARITY:
1362 config->parity = SP_PARITY_NONE;
1363 break;
e432ce60
ML		 1364 case ODDPARITY:
1365 config->parity = SP_PARITY_ODD;
1366 break;
067417af
ML		 1367 case EVENPARITY:
1368 config->parity = SP_PARITY_EVEN;
1369 break;
e432ce60
ML		 1370 case MARKPARITY:
1371 config->parity = SP_PARITY_MARK;
1372 break;
1373 case SPACEPARITY:
1374 config->parity = SP_PARITY_SPACE;
067417af
ML		 1375 break;
1376 default:
1377 config->parity = -1;
1378 }
1379 else
1380 config->parity = SP_PARITY_NONE;
1381
e33ab9aa 1382 switch (data->dcb.StopBits) {
067417af
ML		 1383 case ONESTOPBIT:
1384 config->stopbits = 1;
1385 break;
1386 case TWOSTOPBITS:
1387 config->stopbits = 2;
1388 break;
1389 default:
1390 config->stopbits = -1;
1391 }
1392
e33ab9aa 1393 switch (data->dcb.fRtsControl) {
eac329d2
UH		 1394 case RTS_CONTROL_DISABLE:
1395 config->rts = SP_RTS_OFF;
1396 break;
1397 case RTS_CONTROL_ENABLE:
1398 config->rts = SP_RTS_ON;
1399 break;
1400 case RTS_CONTROL_HANDSHAKE:
1401 config->rts = SP_RTS_FLOW_CONTROL;
1402 break;
1403 default:
1404 config->rts = -1;
067417af
ML		 1405 }
1406
e33ab9aa 1407 config->cts = data->dcb.fOutxCtsFlow ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
067417af 1408
e33ab9aa 1409 switch (data->dcb.fDtrControl) {
eac329d2
UH		 1410 case DTR_CONTROL_DISABLE:
1411 config->dtr = SP_DTR_OFF;
1412 break;
1413 case DTR_CONTROL_ENABLE:
1414 config->dtr = SP_DTR_ON;
1415 break;
1416 case DTR_CONTROL_HANDSHAKE:
1417 config->dtr = SP_DTR_FLOW_CONTROL;
1418 break;
1419 default:
1420 config->dtr = -1;
067417af
ML		 1421 }
1422
e33ab9aa
ML		 1423 config->dsr = data->dcb.fOutxDsrFlow ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1424
c6754b45
ML		 1425 if (data->dcb.fInX) {
1426 if (data->dcb.fOutX)
1427 config->xon_xoff = SP_XONXOFF_INOUT;
1428 else
1429 config->xon_xoff = SP_XONXOFF_IN;
1430 } else {
1431 if (data->dcb.fOutX)
1432 config->xon_xoff = SP_XONXOFF_OUT;
1433 else
1434 config->xon_xoff = SP_XONXOFF_DISABLED;
1435 }
1436
e33ab9aa
ML		 1437#else // !_WIN32
1438
1439 if (tcgetattr(port->fd, &data->term) < 0)
c33efc48 1440 RETURN_FAIL("tcgetattr() failed");
e33ab9aa
ML		 1441
1442 if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0)
c33efc48 1443 RETURN_FAIL("TIOCMGET ioctl failed");
40978c2b
ML		 1444
1445#ifdef USE_TERMIOX
68ec29db
ML		 1446 int ret = get_flow(port->fd, &data->flow);
1447
1448 if (ret == SP_ERR_FAIL && errno == EINVAL)
1449 data->termiox_supported = 0;
1450 else if (ret < 0)
c33efc48 1451 RETURN_CODEVAL(ret);
68ec29db
ML		 1452 else
1453 data->termiox_supported = 1;
1454#else
1455 data->termiox_supported = 0;
40978c2b
ML		 1456#endif
1457
067417af 1458 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
e33ab9aa 1459 if (cfgetispeed(&data->term) == std_baudrates[i].index) {
067417af
ML		 1460 config->baudrate = std_baudrates[i].value;
1461 break;
1462 }
1463 }
1464
31b3a8f5
MH		 1465 if (i == NUM_STD_BAUDRATES) {
1466#ifdef __APPLE__
1467 config->baudrate = (int)data->term.c_ispeed;
7a6d2196
ML		 1468#elif defined(__linux__)
1469 TRY(get_baudrate(port->fd, &config->baudrate));
31b3a8f5 1470#else
067417af 1471 config->baudrate = -1;
31b3a8f5
MH		 1472#endif
1473 }
067417af 1474
e33ab9aa 1475 switch (data->term.c_cflag & CSIZE) {
067417af
ML		 1476 case CS8:
1477 config->bits = 8;
1478 break;
1479 case CS7:
1480 config->bits = 7;
1481 break;
1482 case CS6:
1483 config->bits = 6;
1484 break;
1485 case CS5:
1486 config->bits = 5;
1487 break;
1488 default:
1489 config->bits = -1;
1490 }
1491
e33ab9aa 1492 if (!(data->term.c_cflag & PARENB) && (data->term.c_iflag & IGNPAR))
067417af 1493 config->parity = SP_PARITY_NONE;
e33ab9aa 1494 else if (!(data->term.c_cflag & PARENB) || (data->term.c_iflag & IGNPAR))
067417af 1495 config->parity = -1;
c3e05092 1496#ifdef CMSPAR
e432ce60
ML		 1497 else if (data->term.c_cflag & CMSPAR)
1498 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_MARK : SP_PARITY_SPACE;
c3e05092 1499#endif
067417af 1500 else
e33ab9aa 1501 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_ODD : SP_PARITY_EVEN;
067417af 1502
e33ab9aa 1503 config->stopbits = (data->term.c_cflag & CSTOPB) ? 2 : 1;
067417af 1504
e33ab9aa 1505 if (data->term.c_cflag & CRTSCTS) {
067417af
ML		 1506 config->rts = SP_RTS_FLOW_CONTROL;
1507 config->cts = SP_CTS_FLOW_CONTROL;
1508 } else {
68ec29db 1509 if (data->termiox_supported && data->flow & RTS_FLOW)
40978c2b
ML		 1510 config->rts = SP_RTS_FLOW_CONTROL;
1511 else
1512 config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
1513
68ec29db
ML		 1514 config->cts = (data->termiox_supported && data->flow & CTS_FLOW) ?
1515 SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
067417af
ML		 1516 }
1517
68ec29db 1518 if (data->termiox_supported && data->flow & DTR_FLOW)
40978c2b
ML		 1519 config->dtr = SP_DTR_FLOW_CONTROL;
1520 else
1521 config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
1522
68ec29db
ML		 1523 config->dsr = (data->termiox_supported && data->flow & DSR_FLOW) ?
1524 SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
705bdc69 1525
e29b93a5
ML		 1526 if (data->term.c_iflag & IXOFF) {
1527 if (data->term.c_iflag & IXON)
1528 config->xon_xoff = SP_XONXOFF_INOUT;
1529 else
1530 config->xon_xoff = SP_XONXOFF_IN;
1531 } else {
1532 if (data->term.c_iflag & IXON)
1533 config->xon_xoff = SP_XONXOFF_OUT;
1534 else
1535 config->xon_xoff = SP_XONXOFF_DISABLED;
1536 }
067417af
ML		 1537#endif
1538
c33efc48 1539 RETURN_OK();
067417af
ML		 1540}
1541
7a6d2196 1542static enum sp_return set_config(struct sp_port *port, struct port_data *data,
eb6ed20f 1543 const struct sp_port_config *config)
18fc2dd1 1544{
e33ab9aa 1545 unsigned int i;
31b3a8f5
MH		 1546#ifdef __APPLE__
1547 BAUD_TYPE baud_nonstd;
1548
1549 baud_nonstd = B0;
1550#endif
7a6d2196
ML		 1551#ifdef __linux__
1552 int baud_nonstd = 0;
1553#endif
18fc2dd1 1554
c33efc48
ML		 1555 TRACE("%p, %p, %p", port, data, config);
1556
ea667be7
ML		 1557 DEBUG("Setting configuration for port %s", port->name);
1558
e33ab9aa 1559#ifdef _WIN32
eac329d2 1560 if (config->baudrate >= 0) {
e33ab9aa
ML		 1561 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1562 if (config->baudrate == std_baudrates[i].value) {
1563 data->dcb.BaudRate = std_baudrates[i].index;
1564 break;
1565 }
1566 }
18fc2dd1 1567
e33ab9aa
ML		 1568 if (i == NUM_STD_BAUDRATES)
1569 data->dcb.BaudRate = config->baudrate;
1570 }
18fc2dd1 1571
e33ab9aa
ML		 1572 if (config->bits >= 0)
1573 data->dcb.ByteSize = config->bits;
1574
1575 if (config->parity >= 0) {
1576 switch (config->parity) {
1577 /* Note: There's also SPACEPARITY, MARKPARITY (unneeded so far). */
1578 case SP_PARITY_NONE:
1579 data->dcb.Parity = NOPARITY;
1580 break;
e432ce60
ML		 1581 case SP_PARITY_ODD:
1582 data->dcb.Parity = ODDPARITY;
1583 break;
e33ab9aa
ML		 1584 case SP_PARITY_EVEN:
1585 data->dcb.Parity = EVENPARITY;
1586 break;
e432ce60
ML		 1587 case SP_PARITY_MARK:
1588 data->dcb.Parity = MARKPARITY;
1589 break;
1590 case SP_PARITY_SPACE:
1591 data->dcb.Parity = SPACEPARITY;
e33ab9aa
ML		 1592 break;
1593 default:
c33efc48 1594 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
e33ab9aa 1595 }
18fc2dd1
ML		 1596 }
1597
e33ab9aa
ML		 1598 if (config->stopbits >= 0) {
1599 switch (config->stopbits) {
1600 /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
1601 case 1:
1602 data->dcb.StopBits = ONESTOPBIT;
1603 break;
1604 case 2:
1605 data->dcb.StopBits = TWOSTOPBITS;
1606 break;
1607 default:
c33efc48 1608 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bit setting");
e33ab9aa
ML		 1609 }
1610 }
1611
1612 if (config->rts >= 0) {
1613 switch (config->rts) {
1614 case SP_RTS_OFF:
1615 data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
1616 break;
1617 case SP_RTS_ON:
1618 data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
1619 break;
1620 case SP_RTS_FLOW_CONTROL:
1621 data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
1622 break;
1623 default:
c33efc48 1624 RETURN_ERROR(SP_ERR_ARG, "Invalid RTS setting");
e33ab9aa
ML		 1625 }
1626 }
1627
1628 if (config->cts >= 0) {
1629 switch (config->cts) {
1630 case SP_CTS_IGNORE:
1631 data->dcb.fOutxCtsFlow = FALSE;
1632 break;
1633 case SP_CTS_FLOW_CONTROL:
1634 data->dcb.fOutxCtsFlow = TRUE;
1635 break;
1636 default:
c33efc48 1637 RETURN_ERROR(SP_ERR_ARG, "Invalid CTS setting");
e33ab9aa
ML		 1638 }
1639 }
1640
1641 if (config->dtr >= 0) {
1642 switch (config->dtr) {
1643 case SP_DTR_OFF:
1644 data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
1645 break;
1646 case SP_DTR_ON:
1647 data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
1648 break;
1649 case SP_DTR_FLOW_CONTROL:
1650 data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
1651 break;
1652 default:
c33efc48 1653 RETURN_ERROR(SP_ERR_ARG, "Invalid DTR setting");
e33ab9aa
ML		 1654 }
1655 }
1656
1657 if (config->dsr >= 0) {
1658 switch (config->dsr) {
1659 case SP_DSR_IGNORE:
1660 data->dcb.fOutxDsrFlow = FALSE;
1661 break;
1662 case SP_DSR_FLOW_CONTROL:
1663 data->dcb.fOutxDsrFlow = TRUE;
1664 break;
1665 default:
c33efc48 1666 RETURN_ERROR(SP_ERR_ARG, "Invalid DSR setting");
e33ab9aa 1667 }
18fc2dd1
ML		 1668 }
1669
e33ab9aa
ML		 1670 if (config->xon_xoff >= 0) {
1671 switch (config->xon_xoff) {
1672 case SP_XONXOFF_DISABLED:
1673 data->dcb.fInX = FALSE;
1674 data->dcb.fOutX = FALSE;
1675 break;
1676 case SP_XONXOFF_IN:
1677 data->dcb.fInX = TRUE;
1678 data->dcb.fOutX = FALSE;
1679 break;
1680 case SP_XONXOFF_OUT:
1681 data->dcb.fInX = FALSE;
1682 data->dcb.fOutX = TRUE;
1683 break;
1684 case SP_XONXOFF_INOUT:
1685 data->dcb.fInX = TRUE;
1686 data->dcb.fOutX = TRUE;
1687 break;
1688 default:
c33efc48 1689 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
e33ab9aa
ML		 1690 }
1691 }
1692
1693 if (!SetCommState(port->hdl, &data->dcb))
c33efc48 1694 RETURN_FAIL("SetCommState() failed");
e33ab9aa 1695
31b3a8f5 1696#else /* !_WIN32 */
e33ab9aa 1697
7a6d2196
ML		 1698 int controlbits;
1699
eac329d2 1700 if (config->baudrate >= 0) {
e33ab9aa
ML		 1701 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1702 if (config->baudrate == std_baudrates[i].value) {
1703 if (cfsetospeed(&data->term, std_baudrates[i].index) < 0)
c33efc48 1704 RETURN_FAIL("cfsetospeed() failed");
e33ab9aa
ML		 1705
1706 if (cfsetispeed(&data->term, std_baudrates[i].index) < 0)
c33efc48 1707 RETURN_FAIL("cfsetispeed() failed");
e33ab9aa
ML		 1708 break;
1709 }
1710 }
1711
31b3a8f5
MH		 1712 /* Non-standard baud rate */
1713 if (i == NUM_STD_BAUDRATES) {
1714#ifdef __APPLE__
24abdb68 1715 /* Set "dummy" baud rate. */
31b3a8f5 1716 if (cfsetspeed(&data->term, B9600) < 0)
c33efc48 1717 RETURN_FAIL("cfsetspeed() failed");
31b3a8f5 1718 baud_nonstd = config->baudrate;
7a6d2196
ML		 1719#elif defined(__linux__)
1720 baud_nonstd = 1;
31b3a8f5 1721#else
c33efc48 1722 RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported");
31b3a8f5
MH		 1723#endif
1724 }
e33ab9aa
ML		 1725 }
1726
1727 if (config->bits >= 0) {
1728 data->term.c_cflag &= ~CSIZE;
1729 switch (config->bits) {
1730 case 8:
1731 data->term.c_cflag |= CS8;
1732 break;
1733 case 7:
1734 data->term.c_cflag |= CS7;
1735 break;
1736 case 6:
1737 data->term.c_cflag |= CS6;
1738 break;
23922313
UH		 1739 case 5:
1740 data->term.c_cflag |= CS5;
1741 break;
e33ab9aa 1742 default:
c33efc48 1743 RETURN_ERROR(SP_ERR_ARG, "Invalid data bits setting");
e33ab9aa
ML		 1744 }
1745 }
1746
1747 if (config->parity >= 0) {
1748 data->term.c_iflag &= ~IGNPAR;
c3e05092
UH		 1749 data->term.c_cflag &= ~(PARENB | PARODD);
1750#ifdef CMSPAR
1751 data->term.c_cflag &= ~CMSPAR;
1752#endif
e33ab9aa
ML		 1753 switch (config->parity) {
1754 case SP_PARITY_NONE:
1755 data->term.c_iflag |= IGNPAR;
1756 break;
1757 case SP_PARITY_EVEN:
1758 data->term.c_cflag |= PARENB;
1759 break;
1760 case SP_PARITY_ODD:
1761 data->term.c_cflag |= PARENB | PARODD;
1762 break;
afb518f0 1763#ifdef CMSPAR
e432ce60 1764 case SP_PARITY_MARK:
c3e05092 1765 data->term.c_cflag |= PARENB | PARODD;
c3e05092 1766 data->term.c_cflag |= CMSPAR;
e432ce60
ML		 1767 break;
1768 case SP_PARITY_SPACE:
c3e05092 1769 data->term.c_cflag |= PARENB;
c3e05092 1770 data->term.c_cflag |= CMSPAR;
e432ce60 1771 break;
afb518f0
ML		 1772#else
1773 case SP_PARITY_MARK:
1774 case SP_PARITY_SPACE:
1775 RETURN_ERROR(SP_ERR_SUPP, "Mark/space parity not supported");
1776#endif
e33ab9aa 1777 default:
c33efc48 1778 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
e33ab9aa
ML		 1779 }
1780 }
1781
1782 if (config->stopbits >= 0) {
1783 data->term.c_cflag &= ~CSTOPB;
1784 switch (config->stopbits) {
1785 case 1:
1786 data->term.c_cflag &= ~CSTOPB;
1787 break;
1788 case 2:
1789 data->term.c_cflag |= CSTOPB;
1790 break;
1791 default:
c33efc48 1792 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bits setting");
e33ab9aa
ML		 1793 }
1794 }
1795
eac329d2 1796 if (config->rts >= 0 || config->cts >= 0) {
68ec29db
ML		 1797 if (data->termiox_supported) {
1798 data->flow &= ~(RTS_FLOW | CTS_FLOW);
1799 switch (config->rts) {
1800 case SP_RTS_OFF:
1801 case SP_RTS_ON:
1802 controlbits = TIOCM_RTS;
1803 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
c33efc48 1804 RETURN_FAIL("Setting RTS signal level failed");
68ec29db
ML		 1805 break;
1806 case SP_RTS_FLOW_CONTROL:
1807 data->flow |= RTS_FLOW;
1808 break;
1809 default:
1810 break;
e33ab9aa 1811 }
68ec29db
ML		 1812 if (config->cts == SP_CTS_FLOW_CONTROL)
1813 data->flow |= CTS_FLOW;
e33ab9aa 1814
68ec29db 1815 if (data->flow & (RTS_FLOW | CTS_FLOW))
e33ab9aa 1816 data->term.c_iflag |= CRTSCTS;
68ec29db
ML		 1817 else
1818 data->term.c_iflag &= ~CRTSCTS;
1819 } else {
1820 /* Asymmetric use of RTS/CTS not supported. */
1821 if (data->term.c_iflag & CRTSCTS) {
1822 /* Flow control can only be disabled for both RTS & CTS together. */
1823 if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) {
1824 if (config->cts != SP_CTS_IGNORE)
c33efc48 1825 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
68ec29db
ML		 1826 }
1827 if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) {
1828 if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL)
c33efc48 1829 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
68ec29db 1830 }
e33ab9aa 1831 } else {
68ec29db
ML		 1832 /* Flow control can only be enabled for both RTS & CTS together. */
1833 if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) ||
1834 ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL)))
c33efc48 1835 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be enabled together");
68ec29db
ML		 1836 }
1837
1838 if (config->rts >= 0) {
1839 if (config->rts == SP_RTS_FLOW_CONTROL) {
1840 data->term.c_iflag |= CRTSCTS;
1841 } else {
1842 controlbits = TIOCM_RTS;
1843 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
1844 &controlbits) < 0)
c33efc48 1845 RETURN_FAIL("Setting RTS signal level failed");
68ec29db 1846 }
e33ab9aa
ML		 1847 }
1848 }
1849 }
1850
eac329d2 1851 if (config->dtr >= 0 || config->dsr >= 0) {
68ec29db
ML		 1852 if (data->termiox_supported) {
1853 data->flow &= ~(DTR_FLOW | DSR_FLOW);
1854 switch (config->dtr) {
1855 case SP_DTR_OFF:
1856 case SP_DTR_ON:
1857 controlbits = TIOCM_DTR;
1858 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
c33efc48 1859 RETURN_FAIL("Setting DTR signal level failed");
68ec29db
ML		 1860 break;
1861 case SP_DTR_FLOW_CONTROL:
1862 data->flow |= DTR_FLOW;
1863 break;
1864 default:
1865 break;
1866 }
1867 if (config->dsr == SP_DSR_FLOW_CONTROL)
1868 data->flow |= DSR_FLOW;
1869 } else {
1870 /* DTR/DSR flow control not supported. */
1871 if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
c33efc48 1872 RETURN_ERROR(SP_ERR_SUPP, "DTR/DSR flow control not supported");
e33ab9aa 1873
68ec29db
ML		 1874 if (config->dtr >= 0) {
1875 controlbits = TIOCM_DTR;
1876 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
1877 &controlbits) < 0)
c33efc48 1878 RETURN_FAIL("Setting DTR signal level failed");
68ec29db 1879 }
e33ab9aa
ML		 1880 }
1881 }
1882
1883 if (config->xon_xoff >= 0) {
1884 data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
1885 switch (config->xon_xoff) {
1886 case SP_XONXOFF_DISABLED:
1887 break;
1888 case SP_XONXOFF_IN:
1889 data->term.c_iflag |= IXOFF;
1890 break;
1891 case SP_XONXOFF_OUT:
1892 data->term.c_iflag |= IXON | IXANY;
1893 break;
1894 case SP_XONXOFF_INOUT:
1895 data->term.c_iflag |= IXON | IXOFF | IXANY;
1896 break;
1897 default:
c33efc48 1898 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
e33ab9aa
ML		 1899 }
1900 }
1901
3f5c06d0 1902 if (tcsetattr(port->fd, TCSANOW, &data->term) < 0)
c33efc48 1903 RETURN_FAIL("tcsetattr() failed");
31b3a8f5
MH		 1904
1905#ifdef __APPLE__
1906 if (baud_nonstd != B0) {
1907 if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1)
c33efc48 1908 RETURN_FAIL("IOSSIOSPEED ioctl failed");
31b3a8f5
MH		 1909 /* Set baud rates in data->term to correct, but incompatible
1910 * with tcsetattr() value, same as delivered by tcgetattr(). */
1911 if (cfsetspeed(&data->term, baud_nonstd) < 0)
c33efc48 1912 RETURN_FAIL("cfsetspeed() failed");
31b3a8f5 1913 }
7a6d2196
ML		 1914#elif defined(__linux__)
1915 if (baud_nonstd)
1916 TRY(set_baudrate(port->fd, config->baudrate));
40978c2b 1917#ifdef USE_TERMIOX
68ec29db
ML		 1918 if (data->termiox_supported)
1919 TRY(set_flow(port->fd, data->flow));
40978c2b 1920#endif
7a6d2196 1921#endif
31b3a8f5
MH		 1922
1923#endif /* !_WIN32 */
e33ab9aa 1924
c33efc48 1925 RETURN_OK();
e33ab9aa
ML		 1926}
1927
9b1502ef
ML		 1928enum sp_return sp_new_config(struct sp_port_config **config_ptr)
1929{
59131d60 1930 struct sp_port_config *config;
9b1502ef 1931
00d8c56d
UH		 1932 TRACE("%p", config_ptr);
1933
9b1502ef
ML		 1934 if (!config_ptr)
1935 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
1936
59131d60
ML		 1937 *config_ptr = NULL;
1938
1939 if (!(config = malloc(sizeof(struct sp_port_config))))
9b1502ef
ML		 1940 RETURN_ERROR(SP_ERR_MEM, "config malloc failed");
1941
59131d60
ML		 1942 config->baudrate = -1;
1943 config->bits = -1;
1944 config->parity = -1;
1945 config->stopbits = -1;
1946 config->rts = -1;
1947 config->cts = -1;
1948 config->dtr = -1;
1949 config->dsr = -1;
1950
1951 *config_ptr = config;
1952
9b1502ef
ML		 1953 RETURN_OK();
1954}
1955
1956void sp_free_config(struct sp_port_config *config)
1957{
1958 TRACE("%p", config);
1959
1960 if (!config)
1961 DEBUG("Null config");
1962 else
1963 free(config);
1964
1965 RETURN();
1966}
1967
70cd37de
ML		 1968enum sp_return sp_get_config(struct sp_port *port, struct sp_port_config *config)
1969{
1970 struct port_data data;
1971
1972 TRACE("%p, %p", port, config);
1973
1974 CHECK_OPEN_PORT();
1975
1976 if (!config)
9b1502ef 1977 RETURN_ERROR(SP_ERR_ARG, "Null config");
70cd37de
ML		 1978
1979 TRY(get_config(port, &data, config));
1980
1981 RETURN_OK();
1982}
1983
eb6ed20f 1984enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *config)
e33ab9aa 1985{
8f189c4c 1986 struct port_data data;
e33ab9aa
ML		 1987 struct sp_port_config prev_config;
1988
c33efc48
ML		 1989 TRACE("%p, %p", port, config);
1990
dec10e31 1991 CHECK_OPEN_PORT();
823690ae
ML		 1992
1993 if (!config)
c33efc48 1994 RETURN_ERROR(SP_ERR_ARG, "Null config");
823690ae 1995
e33ab9aa
ML		 1996 TRY(get_config(port, &data, &prev_config));
1997 TRY(set_config(port, &data, config));
74510d4b 1998
c33efc48 1999 RETURN_OK();
74510d4b
ML		 2000}
2001
9b1502ef
ML		 2002#define CREATE_ACCESSORS(x, type) \
2003enum sp_return sp_set_##x(struct sp_port *port, type x) { \
8f189c4c 2004 struct port_data data; \
e33ab9aa 2005 struct sp_port_config config; \
c33efc48 2006 TRACE("%p, %d", port, x); \
dec10e31 2007 CHECK_OPEN_PORT(); \
e33ab9aa
ML		 2008 TRY(get_config(port, &data, &config)); \
2009 config.x = x; \
2010 TRY(set_config(port, &data, &config)); \
c33efc48 2011 RETURN_OK(); \
9b1502ef
ML		 2012} \
2013enum sp_return sp_get_config_##x(const struct sp_port_config *config, type *x) { \
00d8c56d 2014 TRACE("%p, %p", config, x); \
9b1502ef
ML		 2015 if (!config) \
2016 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2017 *x = config->x; \
2018 RETURN_OK(); \
2019} \
2020enum sp_return sp_set_config_##x(struct sp_port_config *config, type x) { \
2021 TRACE("%p, %d", config, x); \
2022 if (!config) \
2023 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2024 config->x = x; \
2025 RETURN_OK(); \
9069c2fb
ML		 2026}
2027
9b1502ef
ML		 2028CREATE_ACCESSORS(baudrate, int)
2029CREATE_ACCESSORS(bits, int)
2030CREATE_ACCESSORS(parity, enum sp_parity)
2031CREATE_ACCESSORS(stopbits, int)
2032CREATE_ACCESSORS(rts, enum sp_rts)
2033CREATE_ACCESSORS(cts, enum sp_cts)
2034CREATE_ACCESSORS(dtr, enum sp_dtr)
2035CREATE_ACCESSORS(dsr, enum sp_dsr)
2036CREATE_ACCESSORS(xon_xoff, enum sp_xonxoff)
2037
2038enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config, enum sp_flowcontrol flowcontrol)
e33ab9aa 2039{
9b1502ef
ML		 2040 if (!config)
2041 RETURN_ERROR(SP_ERR_ARG, "Null configuration");
dec10e31
ML		 2042
2043 if (flowcontrol > SP_FLOWCONTROL_DTRDSR)
2044 RETURN_ERROR(SP_ERR_ARG, "Invalid flow control setting");
823690ae 2045
e33ab9aa 2046 if (flowcontrol == SP_FLOWCONTROL_XONXOFF)
9b1502ef 2047 config->xon_xoff = SP_XONXOFF_INOUT;
e33ab9aa 2048 else
9b1502ef 2049 config->xon_xoff = SP_XONXOFF_DISABLED;
e33ab9aa
ML		 2050
2051 if (flowcontrol == SP_FLOWCONTROL_RTSCTS) {
9b1502ef
ML		 2052 config->rts = SP_RTS_FLOW_CONTROL;
2053 config->cts = SP_CTS_FLOW_CONTROL;
e33ab9aa 2054 } else {
9b1502ef
ML		 2055 if (config->rts == SP_RTS_FLOW_CONTROL)
2056 config->rts = SP_RTS_ON;
2057 config->cts = SP_CTS_IGNORE;
e33ab9aa
ML		 2058 }
2059
2060 if (flowcontrol == SP_FLOWCONTROL_DTRDSR) {
9b1502ef
ML		 2061 config->dtr = SP_DTR_FLOW_CONTROL;
2062 config->dsr = SP_DSR_FLOW_CONTROL;
e33ab9aa 2063 } else {
9b1502ef
ML		 2064 if (config->dtr == SP_DTR_FLOW_CONTROL)
2065 config->dtr = SP_DTR_ON;
2066 config->dsr = SP_DSR_IGNORE;
e33ab9aa
ML		 2067 }
2068
9b1502ef
ML		 2069 RETURN_OK();
2070}
2071
2072enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol)
2073{
2074 struct port_data data;
2075 struct sp_port_config config;
2076
2077 TRACE("%p, %d", port, flowcontrol);
2078
2079 CHECK_OPEN_PORT();
2080
2081 TRY(get_config(port, &data, &config));
2082
2083 TRY(sp_set_config_flowcontrol(&config, flowcontrol));
2084
e33ab9aa
ML		 2085 TRY(set_config(port, &data, &config));
2086
c33efc48 2087 RETURN_OK();
e33ab9aa
ML		 2088}
2089
8cf7c697
ML		 2090enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals)
2091{
c33efc48
ML		 2092 TRACE("%p, %p", port, signals);
2093
dec10e31 2094 CHECK_OPEN_PORT();
8cf7c697
ML		 2095
2096 if (!signals)
c33efc48 2097 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
8cf7c697 2098
ea667be7
ML		 2099 DEBUG("Getting control signals for port %s", port->name);
2100
8cf7c697
ML		 2101 *signals = 0;
2102#ifdef _WIN32
2103 DWORD bits;
2104 if (GetCommModemStatus(port->hdl, &bits) == 0)
c33efc48 2105 RETURN_FAIL("GetCommModemStatus() failed");
8cf7c697
ML		 2106 if (bits & MS_CTS_ON)
2107 *signals |= SP_SIG_CTS;
2108 if (bits & MS_DSR_ON)
2109 *signals |= SP_SIG_DSR;
8cf7c697 2110 if (bits & MS_RLSD_ON)
a6cda1e8
ML		 2111 *signals |= SP_SIG_DCD;
2112 if (bits & MS_RING_ON)
8cf7c697
ML		 2113 *signals |= SP_SIG_RI;
2114#else
2115 int bits;
2116 if (ioctl(port->fd, TIOCMGET, &bits) < 0)
c33efc48 2117 RETURN_FAIL("TIOCMGET ioctl failed");
8cf7c697
ML		 2118 if (bits & TIOCM_CTS)
2119 *signals |= SP_SIG_CTS;
2120 if (bits & TIOCM_DSR)
2121 *signals |= SP_SIG_DSR;
2122 if (bits & TIOCM_CAR)
2123 *signals |= SP_SIG_DCD;
2124 if (bits & TIOCM_RNG)
2125 *signals |= SP_SIG_RI;
2126#endif
c33efc48 2127 RETURN_OK();
8cf7c697
ML		 2128}
2129
90cc3ee6
ML		 2130enum sp_return sp_start_break(struct sp_port *port)
2131{
c33efc48
ML		 2132 TRACE("%p", port);
2133
dec10e31 2134 CHECK_OPEN_PORT();
90cc3ee6
ML		 2135#ifdef _WIN32
2136 if (SetCommBreak(port->hdl) == 0)
c33efc48 2137 RETURN_FAIL("SetCommBreak() failed");
90cc3ee6
ML		 2138#else
2139 if (ioctl(port->fd, TIOCSBRK, 1) < 0)
c33efc48 2140 RETURN_FAIL("TIOCSBRK ioctl failed");
90cc3ee6
ML		 2141#endif
2142
c33efc48 2143 RETURN_OK();
90cc3ee6
ML		 2144}
2145
2146enum sp_return sp_end_break(struct sp_port *port)
2147{
c33efc48
ML		 2148 TRACE("%p", port);
2149
dec10e31 2150 CHECK_OPEN_PORT();
90cc3ee6
ML		 2151#ifdef _WIN32
2152 if (ClearCommBreak(port->hdl) == 0)
c33efc48 2153 RETURN_FAIL("ClearCommBreak() failed");
90cc3ee6
ML		 2154#else
2155 if (ioctl(port->fd, TIOCCBRK, 1) < 0)
c33efc48 2156 RETURN_FAIL("TIOCCBRK ioctl failed");
90cc3ee6
ML		 2157#endif
2158
c33efc48 2159 RETURN_OK();
90cc3ee6
ML		 2160}
2161
74510d4b
ML		 2162int sp_last_error_code(void)
2163{
c33efc48 2164 TRACE("");
74510d4b 2165#ifdef _WIN32
c33efc48 2166 RETURN_VALUE("%d", GetLastError());
74510d4b 2167#else
c33efc48 2168 RETURN_VALUE("%d", errno);
74510d4b
ML		 2169#endif
2170}
2171
74510d4b
ML		 2172char *sp_last_error_message(void)
2173{
c33efc48
ML		 2174 TRACE("");
2175
74510d4b
ML		 2176#ifdef _WIN32
2177 LPVOID message;
2178 DWORD error = GetLastError();
2179
2180 FormatMessage(
2181 FORMAT_MESSAGE_ALLOCATE_BUFFER |
2182 FORMAT_MESSAGE_FROM_SYSTEM |
2183 FORMAT_MESSAGE_IGNORE_INSERTS,
2184 NULL,
2185 error,
2186 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
2187 (LPTSTR) &message,
2188 0, NULL );
2189
c33efc48 2190 RETURN_VALUE("%s", message);
74510d4b 2191#else
c33efc48 2192 RETURN_VALUE("%s", strerror(errno));
74510d4b
ML		 2193#endif
2194}
2195
74510d4b
ML		 2196void sp_free_error_message(char *message)
2197{
c33efc48
ML		 2198 TRACE("%s", message);
2199
74510d4b
ML		 2200#ifdef _WIN32
2201 LocalFree(message);
64eec30d
ML		 2202#else
2203 (void)message;
74510d4b 2204#endif
c33efc48
ML		 2205
2206 RETURN();
74510d4b 2207}
863b35e6
ML		 2208
2209void sp_set_debug_handler(void (*handler)(const char *format, ...))
2210{
c33efc48
ML		 2211 TRACE("%p", handler);
2212
863b35e6 2213 sp_debug_handler = handler;
c33efc48
ML		 2214
2215 RETURN();
863b35e6
ML		 2216}
2217
2218void sp_default_debug_handler(const char *format, ...)
2219{
2220 va_list args;
2221 va_start(args, format);
2222 if (getenv("LIBSERIALPORT_DEBUG")) {
dd7742fb 2223 fputs("sp: ", stderr);
863b35e6
ML		 2224 vfprintf(stderr, format, args);
2225 }
2226 va_end(args);
2227}
Serial port access library