serialport.c

   1 /*
   2  * This file is part of the libserialport project.
   3  *
   4  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
   5  * Copyright (C) 2010-2012 Uwe Hermann <uwe@hermann-uwe.de>
   6  * Copyright (C) 2013 Martin Ling <martin-libserialport@earth.li>
   7  * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
   8  * Copyright (C) 2014 Aurelien Jacobs <aurel@gnuage.org>
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Lesser General Public License as
  12  * published by the Free Software Foundation, either version 3 of the
  13  * License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24 #include "libserialport.h"
  25 #include "libserialport_internal.h"
  26
  27 static const struct std_baudrate std_baudrates[] = {
  28 #ifdef _WIN32
  29         /*
  30          * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
  31          * have documented CBR_* macros.
  32          */
  33         BAUD(110), BAUD(300), BAUD(600), BAUD(1200), BAUD(2400), BAUD(4800),
  34         BAUD(9600), BAUD(14400), BAUD(19200), BAUD(38400), BAUD(57600),
  35         BAUD(115200), BAUD(128000), BAUD(256000),
  36 #else
  37         BAUD(50), BAUD(75), BAUD(110), BAUD(134), BAUD(150), BAUD(200),
  38         BAUD(300), BAUD(600), BAUD(1200), BAUD(1800), BAUD(2400), BAUD(4800),
  39         BAUD(9600), BAUD(19200), BAUD(38400), BAUD(57600), BAUD(115200),
  40         BAUD(230400),
  41 #if !defined(__APPLE__) && !defined(__OpenBSD__)
  42         BAUD(460800),
  43 #endif
  44 #endif
  45 };
  46
  47 #define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates)
  48
  49 void (*sp_debug_handler)(const char *format, ...) = sp_default_debug_handler;
  50
  51 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
  52         struct sp_port_config *config);
  53
  54 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
  55         const struct sp_port_config *config);
  56
  57 SP_API enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
  58 {
  59         struct sp_port *port;
  60 #ifndef NO_PORT_METADATA
  61         enum sp_return ret;
  62 #endif
  63         int len;
  64
  65         TRACE("%s, %p", portname, port_ptr);
  66
  67         if (!port_ptr)
  68                 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
  69
  70         *port_ptr = NULL;
  71
  72         if (!portname)
  73                 RETURN_ERROR(SP_ERR_ARG, "Null port name");
  74
  75         DEBUG_FMT("Building structure for port %s", portname);
  76
  77         if (!(port = malloc(sizeof(struct sp_port))))
  78                 RETURN_ERROR(SP_ERR_MEM, "Port structure malloc failed");
  79
  80         len = strlen(portname) + 1;
  81
  82         if (!(port->name = malloc(len))) {
  83                 free(port);
  84                 RETURN_ERROR(SP_ERR_MEM, "Port name malloc failed");
  85         }
  86
  87         memcpy(port->name, portname, len);
  88
  89 #ifdef _WIN32
  90         port->usb_path = NULL;
  91         port->hdl = INVALID_HANDLE_VALUE;
  92 #else
  93         port->fd = -1;
  94 #endif
  95
  96         port->description = NULL;
  97         port->transport = SP_TRANSPORT_NATIVE;
  98         port->usb_bus = -1;
  99         port->usb_address = -1;
 100         port->usb_vid = -1;
 101         port->usb_pid = -1;
 102         port->usb_manufacturer = NULL;
 103         port->usb_product = NULL;
 104         port->usb_serial = NULL;
 105         port->bluetooth_address = NULL;
 106
 107 #ifndef NO_PORT_METADATA
 108         if ((ret = get_port_details(port)) != SP_OK) {
 109                 sp_free_port(port);
 110                 return ret;
 111         }
 112 #endif
 113
 114         *port_ptr = port;
 115
 116         RETURN_OK();
 117 }
 118
 119 SP_API char *sp_get_port_name(const struct sp_port *port)
 120 {
 121         TRACE("%p", port);
 122
 123         if (!port)
 124                 return NULL;
 125
 126         RETURN_STRING(port->name);
 127 }
 128
 129 SP_API char *sp_get_port_description(const struct sp_port *port)
 130 {
 131         TRACE("%p", port);
 132
 133         if (!port || !port->description)
 134                 return NULL;
 135
 136         RETURN_STRING(port->description);
 137 }
 138
 139 SP_API enum sp_transport sp_get_port_transport(const struct sp_port *port)
 140 {
 141         TRACE("%p", port);
 142
 143         if (!port)
 144                 RETURN_ERROR(SP_ERR_ARG, "Null port");
 145
 146         RETURN_INT(port->transport);
 147 }
 148
 149 SP_API enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
 150                                                   int *usb_bus,int *usb_address)
 151 {
 152         TRACE("%p", port);
 153
 154         if (!port)
 155                 RETURN_ERROR(SP_ERR_ARG, "Null port");
 156         if (port->transport != SP_TRANSPORT_USB)
 157                 RETURN_ERROR(SP_ERR_ARG, "Port does not use USB transport");
 158         if (port->usb_bus < 0 || port->usb_address < 0)
 159                 RETURN_ERROR(SP_ERR_SUPP, "Bus and address values are not available");
 160
 161         if (usb_bus)
 162                 *usb_bus = port->usb_bus;
 163         if (usb_address)
 164                 *usb_address = port->usb_address;
 165
 166         RETURN_OK();
 167 }
 168
 169 SP_API enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port,
 170                                               int *usb_vid, int *usb_pid)
 171 {
 172         TRACE("%p", port);
 173
 174         if (!port)
 175                 RETURN_ERROR(SP_ERR_ARG, "Null port");
 176         if (port->transport != SP_TRANSPORT_USB)
 177                 RETURN_ERROR(SP_ERR_ARG, "Port does not use USB transport");
 178         if (port->usb_vid < 0 || port->usb_pid < 0)
 179                 RETURN_ERROR(SP_ERR_SUPP, "VID:PID values are not available");
 180
 181         if (usb_vid)
 182                 *usb_vid = port->usb_vid;
 183         if (usb_pid)
 184                 *usb_pid = port->usb_pid;
 185
 186         RETURN_OK();
 187 }
 188
 189 SP_API char *sp_get_port_usb_manufacturer(const struct sp_port *port)
 190 {
 191         TRACE("%p", port);
 192
 193         if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_manufacturer)
 194                 return NULL;
 195
 196         RETURN_STRING(port->usb_manufacturer);
 197 }
 198
 199 SP_API char *sp_get_port_usb_product(const struct sp_port *port)
 200 {
 201         TRACE("%p", port);
 202
 203         if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_product)
 204                 return NULL;
 205
 206         RETURN_STRING(port->usb_product);
 207 }
 208
 209 SP_API char *sp_get_port_usb_serial(const struct sp_port *port)
 210 {
 211         TRACE("%p", port);
 212
 213         if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_serial)
 214                 return NULL;
 215
 216         RETURN_STRING(port->usb_serial);
 217 }
 218
 219 SP_API char *sp_get_port_bluetooth_address(const struct sp_port *port)
 220 {
 221         TRACE("%p", port);
 222
 223         if (!port || port->transport != SP_TRANSPORT_BLUETOOTH
 224             || !port->bluetooth_address)
 225                 return NULL;
 226
 227         RETURN_STRING(port->bluetooth_address);
 228 }
 229
 230 SP_API enum sp_return sp_get_port_handle(const struct sp_port *port,
 231                                          void *result_ptr)
 232 {
 233         TRACE("%p, %p", port, result_ptr);
 234
 235         if (!port)
 236                 RETURN_ERROR(SP_ERR_ARG, "Null port");
 237         if (!result_ptr)
 238                 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
 239
 240 #ifdef _WIN32
 241         HANDLE *handle_ptr = result_ptr;
 242         *handle_ptr = port->hdl;
 243 #else
 244         int *fd_ptr = result_ptr;
 245         *fd_ptr = port->fd;
 246 #endif
 247
 248         RETURN_OK();
 249 }
 250
 251 SP_API enum sp_return sp_copy_port(const struct sp_port *port,
 252                                    struct sp_port **copy_ptr)
 253 {
 254         TRACE("%p, %p", port, copy_ptr);
 255
 256         if (!copy_ptr)
 257                 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
 258
 259         *copy_ptr = NULL;
 260
 261         if (!port)
 262                 RETURN_ERROR(SP_ERR_ARG, "Null port");
 263
 264         if (!port->name)
 265                 RETURN_ERROR(SP_ERR_ARG, "Null port name");
 266
 267         DEBUG("Copying port structure");
 268
 269         RETURN_INT(sp_get_port_by_name(port->name, copy_ptr));
 270 }
 271
 272 SP_API void sp_free_port(struct sp_port *port)
 273 {
 274         TRACE("%p", port);
 275
 276         if (!port) {
 277                 DEBUG("Null port");
 278                 RETURN();
 279         }
 280
 281         DEBUG("Freeing port structure");
 282
 283         if (port->name)
 284                 free(port->name);
 285         if (port->description)
 286                 free(port->description);
 287         if (port->usb_manufacturer)
 288                 free(port->usb_manufacturer);
 289         if (port->usb_product)
 290                 free(port->usb_product);
 291         if (port->usb_serial)
 292                 free(port->usb_serial);
 293         if (port->bluetooth_address)
 294                 free(port->bluetooth_address);
 295 #ifdef _WIN32
 296         if (port->usb_path)
 297                 free(port->usb_path);
 298 #endif
 299
 300         free(port);
 301
 302         RETURN();
 303 }
 304
 305 SP_PRIV struct sp_port **list_append(struct sp_port **list,
 306                                      const char *portname)
 307 {
 308         void *tmp;
 309         unsigned int count;
 310
 311         for (count = 0; list[count]; count++);
 312         if (!(tmp = realloc(list, sizeof(struct sp_port *) * (count + 2))))
 313                 goto fail;
 314         list = tmp;
 315         if (sp_get_port_by_name(portname, &list[count]) != SP_OK)
 316                 goto fail;
 317         list[count + 1] = NULL;
 318         return list;
 319
 320 fail:
 321         sp_free_port_list(list);
 322         return NULL;
 323 }
 324
 325 SP_API enum sp_return sp_list_ports(struct sp_port ***list_ptr)
 326 {
 327 #ifndef NO_ENUMERATION
 328         struct sp_port **list;
 329         int ret;
 330 #endif
 331
 332         TRACE("%p", list_ptr);
 333
 334         if (!list_ptr)
 335                 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
 336
 337         *list_ptr = NULL;
 338
 339 #ifdef NO_ENUMERATION
 340         RETURN_ERROR(SP_ERR_SUPP, "Enumeration not supported on this platform");
 341 #else
 342         DEBUG("Enumerating ports");
 343
 344         if (!(list = malloc(sizeof(struct sp_port *))))
 345                 RETURN_ERROR(SP_ERR_MEM, "Port list malloc failed");
 346
 347         list[0] = NULL;
 348
 349         ret = list_ports(&list);
 350
 351         if (ret == SP_OK) {
 352                 *list_ptr = list;
 353         } else {
 354                 sp_free_port_list(list);
 355                 *list_ptr = NULL;
 356         }
 357
 358         RETURN_CODEVAL(ret);
 359 #endif
 360 }
 361
 362 SP_API void sp_free_port_list(struct sp_port **list)
 363 {
 364         unsigned int i;
 365
 366         TRACE("%p", list);
 367
 368         if (!list) {
 369                 DEBUG("Null list");
 370                 RETURN();
 371         }
 372
 373         DEBUG("Freeing port list");
 374
 375         for (i = 0; list[i]; i++)
 376                 sp_free_port(list[i]);
 377         free(list);
 378
 379         RETURN();
 380 }
 381
 382 #define CHECK_PORT() do { \
 383         if (!port) \
 384                 RETURN_ERROR(SP_ERR_ARG, "Null port"); \
 385         if (!port->name) \
 386                 RETURN_ERROR(SP_ERR_ARG, "Null port name"); \
 387 } while (0)
 388 #ifdef _WIN32
 389 #define CHECK_PORT_HANDLE() do { \
 390         if (port->hdl == INVALID_HANDLE_VALUE) \
 391                 RETURN_ERROR(SP_ERR_ARG, "Invalid port handle"); \
 392 } while (0)
 393 #else
 394 #define CHECK_PORT_HANDLE() do { \
 395         if (port->fd < 0) \
 396                 RETURN_ERROR(SP_ERR_ARG, "Invalid port fd"); \
 397 } while (0)
 398 #endif
 399 #define CHECK_OPEN_PORT() do { \
 400         CHECK_PORT(); \
 401         CHECK_PORT_HANDLE(); \
 402 } while (0)
 403
 404 #ifdef WIN32
 405 /** To be called after port receive buffer is emptied. */
 406 static enum sp_return restart_wait(struct sp_port *port)
 407 {
 408         DWORD wait_result;
 409
 410         if (port->wait_running) {
 411                 /* Check status of running wait operation. */
 412                 if (GetOverlappedResult(port->hdl, &port->wait_ovl,
 413                                 &wait_result, FALSE)) {
 414                         DEBUG("Previous wait completed");
 415                         port->wait_running = FALSE;
 416                 } else if (GetLastError() == ERROR_IO_INCOMPLETE) {
 417                         DEBUG("Previous wait still running");
 418                         RETURN_OK();
 419                 } else {
 420                         RETURN_FAIL("GetOverlappedResult() failed");
 421                 }
 422         }
 423
 424         if (!port->wait_running) {
 425                 /* Start new wait operation. */
 426                 if (WaitCommEvent(port->hdl, &port->events,
 427                                 &port->wait_ovl)) {
 428                         DEBUG("New wait returned, events already pending");
 429                 } else if (GetLastError() == ERROR_IO_PENDING) {
 430                         DEBUG("New wait running in background");
 431                         port->wait_running = TRUE;
 432                 } else {
 433                         RETURN_FAIL("WaitCommEvent() failed");
 434                 }
 435         }
 436
 437         RETURN_OK();
 438 }
 439 #endif
 440
 441 SP_API enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
 442 {
 443         struct port_data data;
 444         struct sp_port_config config;
 445         enum sp_return ret;
 446
 447         TRACE("%p, 0x%x", port, flags);
 448
 449         CHECK_PORT();
 450
 451         if (flags > SP_MODE_READ_WRITE)
 452                 RETURN_ERROR(SP_ERR_ARG, "Invalid flags");
 453
 454         DEBUG_FMT("Opening port %s", port->name);
 455
 456 #ifdef _WIN32
 457         DWORD desired_access = 0, flags_and_attributes = 0, errors;
 458         char *escaped_port_name;
 459         COMSTAT status;
 460
 461         /* Prefix port name with '\\.\' to work with ports above COM9. */
 462         if (!(escaped_port_name = malloc(strlen(port->name) + 5)))
 463                 RETURN_ERROR(SP_ERR_MEM, "Escaped port name malloc failed");
 464         sprintf(escaped_port_name, "\\\\.\\%s", port->name);
 465
 466         /* Map 'flags' to the OS-specific settings. */
 467         flags_and_attributes = FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED;
 468         if (flags & SP_MODE_READ)
 469                 desired_access |= GENERIC_READ;
 470         if (flags & SP_MODE_WRITE)
 471                 desired_access |= GENERIC_WRITE;
 472
 473         port->hdl = CreateFile(escaped_port_name, desired_access, 0, 0,
 474                          OPEN_EXISTING, flags_and_attributes, 0);
 475
 476         free(escaped_port_name);
 477
 478         if (port->hdl == INVALID_HANDLE_VALUE)
 479                 RETURN_FAIL("Port CreateFile() failed");
 480
 481         /* All timeouts initially disabled. */
 482         port->timeouts.ReadIntervalTimeout = 0;
 483         port->timeouts.ReadTotalTimeoutMultiplier = 0;
 484         port->timeouts.ReadTotalTimeoutConstant = 0;
 485         port->timeouts.WriteTotalTimeoutMultiplier = 0;
 486         port->timeouts.WriteTotalTimeoutConstant = 0;
 487
 488         if (SetCommTimeouts(port->hdl, &port->timeouts) == 0) {
 489                 sp_close(port);
 490                 RETURN_FAIL("SetCommTimeouts() failed");
 491         }
 492
 493         /* Prepare OVERLAPPED structures. */
 494 #define INIT_OVERLAPPED(ovl) do { \
 495         memset(&port->ovl, 0, sizeof(port->ovl)); \
 496         port->ovl.hEvent = INVALID_HANDLE_VALUE; \
 497         if ((port->ovl.hEvent = CreateEvent(NULL, TRUE, TRUE, NULL)) \
 498                         == INVALID_HANDLE_VALUE) { \
 499                 sp_close(port); \
 500                 RETURN_FAIL(#ovl "CreateEvent() failed"); \
 501         } \
 502 } while (0)
 503
 504         INIT_OVERLAPPED(read_ovl);
 505         INIT_OVERLAPPED(write_ovl);
 506         INIT_OVERLAPPED(wait_ovl);
 507
 508         /* Set event mask for RX and error events. */
 509         if (SetCommMask(port->hdl, EV_RXCHAR | EV_ERR) == 0) {
 510                 sp_close(port);
 511                 RETURN_FAIL("SetCommMask() failed");
 512         }
 513
 514         port->writing = FALSE;
 515         port->wait_running = FALSE;
 516
 517         ret = restart_wait(port);
 518
 519         if (ret < 0) {
 520                 sp_close(port);
 521                 RETURN_CODEVAL(ret);
 522         }
 523 #else
 524         int flags_local = O_NONBLOCK | O_NOCTTY;
 525
 526         /* Map 'flags' to the OS-specific settings. */
 527         if ((flags & SP_MODE_READ_WRITE) == SP_MODE_READ_WRITE)
 528                 flags_local |= O_RDWR;
 529         else if (flags & SP_MODE_READ)
 530                 flags_local |= O_RDONLY;
 531         else if (flags & SP_MODE_WRITE)
 532                 flags_local |= O_WRONLY;
 533
 534         if ((port->fd = open(port->name, flags_local)) < 0)
 535                 RETURN_FAIL("open() failed");
 536 #endif
 537
 538         ret = get_config(port, &data, &config);
 539
 540         if (ret < 0) {
 541                 sp_close(port);
 542                 RETURN_CODEVAL(ret);
 543         }
 544
 545         /* Set sane port settings. */
 546 #ifdef _WIN32
 547         data.dcb.fBinary = TRUE;
 548         data.dcb.fDsrSensitivity = FALSE;
 549         data.dcb.fErrorChar = FALSE;
 550         data.dcb.fNull = FALSE;
 551         data.dcb.fAbortOnError = FALSE;
 552 #else
 553         /* Turn off all fancy termios tricks, give us a raw channel. */
 554         data.term.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP | INLCR | IGNCR | ICRNL | IMAXBEL);
 555 #ifdef IUCLC
 556         data.term.c_iflag &= ~IUCLC;
 557 #endif
 558         data.term.c_oflag &= ~(OPOST | ONLCR | OCRNL | ONOCR | ONLRET);
 559 #ifdef OLCUC
 560         data.term.c_oflag &= ~OLCUC;
 561 #endif
 562 #ifdef NLDLY
 563         data.term.c_oflag &= ~NLDLY;
 564 #endif
 565 #ifdef CRDLY
 566         data.term.c_oflag &= ~CRDLY;
 567 #endif
 568 #ifdef TABDLY
 569         data.term.c_oflag &= ~TABDLY;
 570 #endif
 571 #ifdef BSDLY
 572         data.term.c_oflag &= ~BSDLY;
 573 #endif
 574 #ifdef VTDLY
 575         data.term.c_oflag &= ~VTDLY;
 576 #endif
 577 #ifdef FFDLY
 578         data.term.c_oflag &= ~FFDLY;
 579 #endif
 580 #ifdef OFILL
 581         data.term.c_oflag &= ~OFILL;
 582 #endif
 583         data.term.c_lflag &= ~(ISIG | ICANON | ECHO | IEXTEN);
 584         data.term.c_cc[VMIN] = 0;
 585         data.term.c_cc[VTIME] = 0;
 586
 587         /* Ignore modem status lines; enable receiver; leave control lines alone on close. */
 588         data.term.c_cflag |= (CLOCAL | CREAD | HUPCL);
 589 #endif
 590
 591 #ifdef _WIN32
 592         if (ClearCommError(port->hdl, &errors, &status) == 0)
 593                 RETURN_FAIL("ClearCommError() failed");
 594 #endif
 595
 596         ret = set_config(port, &data, &config);
 597
 598         if (ret < 0) {
 599                 sp_close(port);
 600                 RETURN_CODEVAL(ret);
 601         }
 602
 603         RETURN_OK();
 604 }
 605
 606 SP_API enum sp_return sp_close(struct sp_port *port)
 607 {
 608         TRACE("%p", port);
 609
 610         CHECK_OPEN_PORT();
 611
 612         DEBUG_FMT("Closing port %s", port->name);
 613
 614 #ifdef _WIN32
 615         /* Returns non-zero upon success, 0 upon failure. */
 616         if (CloseHandle(port->hdl) == 0)
 617                 RETURN_FAIL("Port CloseHandle() failed");
 618         port->hdl = INVALID_HANDLE_VALUE;
 619
 620         /* Close event handles for overlapped structures. */
 621 #define CLOSE_OVERLAPPED(ovl) do { \
 622         if (port->ovl.hEvent != INVALID_HANDLE_VALUE && \
 623                 CloseHandle(port->ovl.hEvent) == 0) \
 624                 RETURN_FAIL(# ovl "event CloseHandle() failed"); \
 625 } while (0)
 626         CLOSE_OVERLAPPED(read_ovl);
 627         CLOSE_OVERLAPPED(write_ovl);
 628         CLOSE_OVERLAPPED(wait_ovl);
 629
 630 #else
 631         /* Returns 0 upon success, -1 upon failure. */
 632         if (close(port->fd) == -1)
 633                 RETURN_FAIL("close() failed");
 634         port->fd = -1;
 635 #endif
 636
 637         RETURN_OK();
 638 }
 639
 640 SP_API enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers)
 641 {
 642         TRACE("%p, 0x%x", port, buffers);
 643
 644         CHECK_OPEN_PORT();
 645
 646         if (buffers > SP_BUF_BOTH)
 647                 RETURN_ERROR(SP_ERR_ARG, "Invalid buffer selection");
 648
 649         const char *buffer_names[] = {"no", "input", "output", "both"};
 650
 651         DEBUG_FMT("Flushing %s buffers on port %s",
 652                 buffer_names[buffers], port->name);
 653
 654 #ifdef _WIN32
 655         DWORD flags = 0;
 656         if (buffers & SP_BUF_INPUT)
 657                 flags |= PURGE_RXCLEAR;
 658         if (buffers & SP_BUF_OUTPUT)
 659                 flags |= PURGE_TXCLEAR;
 660
 661         /* Returns non-zero upon success, 0 upon failure. */
 662         if (PurgeComm(port->hdl, flags) == 0)
 663                 RETURN_FAIL("PurgeComm() failed");
 664
 665         if (buffers & SP_BUF_INPUT)
 666                 TRY(restart_wait(port));
 667 #else
 668         int flags = 0;
 669         if (buffers == SP_BUF_BOTH)
 670                 flags = TCIOFLUSH;
 671         else if (buffers == SP_BUF_INPUT)
 672                 flags = TCIFLUSH;
 673         else if (buffers == SP_BUF_OUTPUT)
 674                 flags = TCOFLUSH;
 675
 676         /* Returns 0 upon success, -1 upon failure. */
 677         if (tcflush(port->fd, flags) < 0)
 678                 RETURN_FAIL("tcflush() failed");
 679 #endif
 680         RETURN_OK();
 681 }
 682
 683 SP_API enum sp_return sp_drain(struct sp_port *port)
 684 {
 685         TRACE("%p", port);
 686
 687         CHECK_OPEN_PORT();
 688
 689         DEBUG_FMT("Draining port %s", port->name);
 690
 691 #ifdef _WIN32
 692         /* Returns non-zero upon success, 0 upon failure. */
 693         if (FlushFileBuffers(port->hdl) == 0)
 694                 RETURN_FAIL("FlushFileBuffers() failed");
 695         RETURN_OK();
 696 #else
 697         int result;
 698         while (1) {
 699 #ifdef __ANDROID__
 700                 int arg = 1;
 701                 result = ioctl(port->fd, TCSBRK, &arg);
 702 #else
 703                 result = tcdrain(port->fd);
 704 #endif
 705                 if (result < 0) {
 706                         if (errno == EINTR) {
 707                                 DEBUG("tcdrain() was interrupted");
 708                                 continue;
 709                         } else {
 710                                 RETURN_FAIL("tcdrain() failed");
 711                         }
 712                 } else {
 713                         RETURN_OK();
 714                 }
 715         }
 716 #endif
 717 }
 718
 719 SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
 720                                         size_t count, unsigned int timeout_ms)
 721 {
 722         TRACE("%p, %p, %d, %d", port, buf, count, timeout_ms);
 723
 724         CHECK_OPEN_PORT();
 725
 726         if (!buf)
 727                 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
 728
 729         if (timeout_ms)
 730                 DEBUG_FMT("Writing %d bytes to port %s, timeout %d ms",
 731                         count, port->name, timeout_ms);
 732         else
 733                 DEBUG_FMT("Writing %d bytes to port %s, no timeout",
 734                         count, port->name);
 735
 736         if (count == 0)
 737                 RETURN_INT(0);
 738
 739 #ifdef _WIN32
 740         DWORD bytes_written = 0;
 741         BOOL result;
 742
 743         /* Wait for previous non-blocking write to complete, if any. */
 744         if (port->writing) {
 745                 DEBUG("Waiting for previous write to complete");
 746                 result = GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE);
 747                 port->writing = 0;
 748                 if (!result)
 749                         RETURN_FAIL("Previous write failed to complete");
 750                 DEBUG("Previous write completed");
 751         }
 752
 753         /* Set timeout. */
 754         if (port->timeouts.WriteTotalTimeoutConstant != timeout_ms) {
 755                 port->timeouts.WriteTotalTimeoutConstant = timeout_ms;
 756                 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
 757                         RETURN_FAIL("SetCommTimeouts() failed");
 758         }
 759
 760         /* Start write. */
 761         if (WriteFile(port->hdl, buf, count, NULL, &port->write_ovl)) {
 762                 DEBUG("Write completed immediately");
 763                 RETURN_INT(count);
 764         } else if (GetLastError() == ERROR_IO_PENDING) {
 765                 DEBUG("Waiting for write to complete");
 766                 if (GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE) == 0)
 767                         RETURN_FAIL("GetOverlappedResult() failed");
 768                 DEBUG_FMT("Write completed, %d/%d bytes written", bytes_written, count);
 769                 RETURN_INT(bytes_written);
 770         } else {
 771                 RETURN_FAIL("WriteFile() failed");
 772         }
 773 #else
 774         size_t bytes_written = 0;
 775         unsigned char *ptr = (unsigned char *) buf;
 776         struct timeval start, delta, now, end = {0, 0};
 777         int started = 0;
 778         fd_set fds;
 779         int result;
 780
 781         if (timeout_ms) {
 782                 /* Get time at start of operation. */
 783                 gettimeofday(&start, NULL);
 784                 /* Define duration of timeout. */
 785                 delta.tv_sec = timeout_ms / 1000;
 786                 delta.tv_usec = (timeout_ms % 1000) * 1000;
 787                 /* Calculate time at which we should give up. */
 788                 timeradd(&start, &delta, &end);
 789         }
 790
 791         FD_ZERO(&fds);
 792         FD_SET(port->fd, &fds);
 793
 794         /* Loop until we have written the requested number of bytes. */
 795         while (bytes_written < count) {
 796                 /*
 797                  * Check timeout only if we have run select() at least once,
 798                  * to avoid any issues if a short timeout is reached before
 799                  * select() is even run.
 800                  */
 801                 if (timeout_ms && started) {
 802                         gettimeofday(&now, NULL);
 803                         if (timercmp(&now, &end, >))
 804                                 /* Timeout has expired. */
 805                                 break;
 806                         timersub(&end, &now, &delta);
 807                 }
 808                 result = select(port->fd + 1, NULL, &fds, NULL, timeout_ms ? &delta : NULL);
 809                 started = 1;
 810                 if (result < 0) {
 811                         if (errno == EINTR) {
 812                                 DEBUG("select() call was interrupted, repeating");
 813                                 continue;
 814                         } else {
 815                                 RETURN_FAIL("select() failed");
 816                         }
 817                 } else if (result == 0) {
 818                         /* Timeout has expired. */
 819                         break;
 820                 }
 821
 822                 /* Do write. */
 823                 result = write(port->fd, ptr, count - bytes_written);
 824
 825                 if (result < 0) {
 826                         if (errno == EAGAIN)
 827                                 /* This shouldn't happen because we did a select() first, but handle anyway. */
 828                                 continue;
 829                         else
 830                                 /* This is an actual failure. */
 831                                 RETURN_FAIL("write() failed");
 832                 }
 833
 834                 bytes_written += result;
 835                 ptr += result;
 836         }
 837
 838         if (bytes_written < count)
 839                 DEBUG("Write timed out");
 840
 841         RETURN_INT(bytes_written);
 842 #endif
 843 }
 844
 845 SP_API enum sp_return sp_nonblocking_write(struct sp_port *port,
 846                                            const void *buf, size_t count)
 847 {
 848         TRACE("%p, %p, %d", port, buf, count);
 849
 850         CHECK_OPEN_PORT();
 851
 852         if (!buf)
 853                 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
 854
 855         DEBUG_FMT("Writing up to %d bytes to port %s", count, port->name);
 856
 857         if (count == 0)
 858                 RETURN_INT(0);
 859
 860 #ifdef _WIN32
 861         DWORD written = 0;
 862         BYTE *ptr = (BYTE *) buf;
 863
 864         /* Check whether previous write is complete. */
 865         if (port->writing) {
 866                 if (HasOverlappedIoCompleted(&port->write_ovl)) {
 867                         DEBUG("Previous write completed");
 868                         port->writing = 0;
 869                 } else {
 870                         DEBUG("Previous write not complete");
 871                         /* Can't take a new write until the previous one finishes. */
 872                         RETURN_INT(0);
 873                 }
 874         }
 875
 876         /* Set timeout. */
 877         if (port->timeouts.WriteTotalTimeoutConstant != 0) {
 878                 port->timeouts.WriteTotalTimeoutConstant = 0;
 879                 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
 880                         RETURN_FAIL("SetCommTimeouts() failed");
 881         }
 882
 883         /*
 884          * Keep writing data until the OS has to actually start an async IO
 885          * for it. At that point we know the buffer is full.
 886          */
 887         while (written < count) {
 888                 /* Copy first byte of user buffer. */
 889                 port->pending_byte = *ptr++;
 890
 891                 /* Start asynchronous write. */
 892                 if (WriteFile(port->hdl, &port->pending_byte, 1, NULL, &port->write_ovl) == 0) {
 893                         if (GetLastError() == ERROR_IO_PENDING) {
 894                                 if (HasOverlappedIoCompleted(&port->write_ovl)) {
 895                                         DEBUG("Asynchronous write completed immediately");
 896                                         port->writing = 0;
 897                                         written++;
 898                                         continue;
 899                                 } else {
 900                                         DEBUG("Asynchronous write running");
 901                                         port->writing = 1;
 902                                         RETURN_INT(++written);
 903                                 }
 904                         } else {
 905                                 /* Actual failure of some kind. */
 906                                 RETURN_FAIL("WriteFile() failed");
 907                         }
 908                 } else {
 909                         DEBUG("Single byte written immediately");
 910                         written++;
 911                 }
 912         }
 913
 914         DEBUG("All bytes written immediately");
 915
 916         RETURN_INT(written);
 917 #else
 918         /* Returns the number of bytes written, or -1 upon failure. */
 919         ssize_t written = write(port->fd, buf, count);
 920
 921         if (written < 0)
 922                 RETURN_FAIL("write() failed");
 923         else
 924                 RETURN_INT(written);
 925 #endif
 926 }
 927
 928 #ifdef _WIN32
 929 /* Restart wait operation if buffer was emptied. */
 930 static enum sp_return restart_wait_if_needed(struct sp_port *port, unsigned int bytes_read)
 931 {
 932         DWORD errors;
 933         COMSTAT comstat;
 934
 935         if (bytes_read == 0)
 936                 RETURN_OK();
 937
 938         if (ClearCommError(port->hdl, &errors, &comstat) == 0)
 939                 RETURN_FAIL("ClearCommError() failed");
 940
 941         if (comstat.cbInQue == 0)
 942                 TRY(restart_wait(port));
 943
 944         RETURN_OK();
 945 }
 946 #endif
 947
 948 SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
 949                                        size_t count, unsigned int timeout_ms)
 950 {
 951         TRACE("%p, %p, %d, %d", port, buf, count, timeout_ms);
 952
 953         CHECK_OPEN_PORT();
 954
 955         if (!buf)
 956                 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
 957
 958         if (timeout_ms)
 959                 DEBUG_FMT("Reading %d bytes from port %s, timeout %d ms",
 960                         count, port->name, timeout_ms);
 961         else
 962                 DEBUG_FMT("Reading %d bytes from port %s, no timeout",
 963                         count, port->name);
 964
 965         if (count == 0)
 966                 RETURN_INT(0);
 967
 968 #ifdef _WIN32
 969         DWORD bytes_read = 0;
 970
 971         /* Set timeout. */
 972         if (port->timeouts.ReadIntervalTimeout != 0 ||
 973                         port->timeouts.ReadTotalTimeoutMultiplier != 0 ||
 974                         port->timeouts.ReadTotalTimeoutConstant != timeout_ms) {
 975                 port->timeouts.ReadIntervalTimeout = 0;
 976                 port->timeouts.ReadTotalTimeoutMultiplier = 0;
 977                 port->timeouts.ReadTotalTimeoutConstant = timeout_ms;
 978                 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
 979                         RETURN_FAIL("SetCommTimeouts() failed");
 980         }
 981
 982         /* Start read. */
 983         if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl)) {
 984                 DEBUG("Read completed immediately");
 985                 bytes_read = count;
 986         } else if (GetLastError() == ERROR_IO_PENDING) {
 987                 DEBUG("Waiting for read to complete");
 988                 if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE) == 0)
 989                         RETURN_FAIL("GetOverlappedResult() failed");
 990                 DEBUG_FMT("Read completed, %d/%d bytes read", bytes_read, count);
 991         } else {
 992                 RETURN_FAIL("ReadFile() failed");
 993         }
 994
 995         TRY(restart_wait_if_needed(port, bytes_read));
 996
 997         RETURN_INT(bytes_read);
 998
 999 #else
1000         size_t bytes_read = 0;
1001         unsigned char *ptr = (unsigned char *) buf;
1002         struct timeval start, delta, now, end = {0, 0};
1003         int started = 0;
1004         fd_set fds;
1005         int result;
1006
1007         if (timeout_ms) {
1008                 /* Get time at start of operation. */
1009                 gettimeofday(&start, NULL);
1010                 /* Define duration of timeout. */
1011                 delta.tv_sec = timeout_ms / 1000;
1012                 delta.tv_usec = (timeout_ms % 1000) * 1000;
1013                 /* Calculate time at which we should give up. */
1014                 timeradd(&start, &delta, &end);
1015         }
1016
1017         FD_ZERO(&fds);
1018         FD_SET(port->fd, &fds);
1019
1020         /* Loop until we have the requested number of bytes. */
1021         while (bytes_read < count) {
1022                 /*
1023                  * Check timeout only if we have run select() at least once,
1024                  * to avoid any issues if a short timeout is reached before
1025                  * select() is even run.
1026                  */
1027                 if (timeout_ms && started) {
1028                         gettimeofday(&now, NULL);
1029                         if (timercmp(&now, &end, >))
1030                                 /* Timeout has expired. */
1031                                 break;
1032                         timersub(&end, &now, &delta);
1033                 }
1034                 result = select(port->fd + 1, &fds, NULL, NULL, timeout_ms ? &delta : NULL);
1035                 started = 1;
1036                 if (result < 0) {
1037                         if (errno == EINTR) {
1038                                 DEBUG("select() call was interrupted, repeating");
1039                                 continue;
1040                         } else {
1041                                 RETURN_FAIL("select() failed");
1042                         }
1043                 } else if (result == 0) {
1044                         /* Timeout has expired. */
1045                         break;
1046                 }
1047
1048                 /* Do read. */
1049                 result = read(port->fd, ptr, count - bytes_read);
1050
1051                 if (result < 0) {
1052                         if (errno == EAGAIN)
1053                                 /*
1054                                  * This shouldn't happen because we did a
1055                                  * select() first, but handle anyway.
1056                                  */
1057                                 continue;
1058                         else
1059                                 /* This is an actual failure. */
1060                                 RETURN_FAIL("read() failed");
1061                 }
1062
1063                 bytes_read += result;
1064                 ptr += result;
1065         }
1066
1067         if (bytes_read < count)
1068                 DEBUG("Read timed out");
1069
1070         RETURN_INT(bytes_read);
1071 #endif
1072 }
1073
1074 SP_API enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf,
1075                                           size_t count)
1076 {
1077         TRACE("%p, %p, %d", port, buf, count);
1078
1079         CHECK_OPEN_PORT();
1080
1081         if (!buf)
1082                 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
1083
1084         DEBUG_FMT("Reading up to %d bytes from port %s", count, port->name);
1085
1086 #ifdef _WIN32
1087         DWORD bytes_read;
1088
1089         /* Set timeout. */
1090         if (port->timeouts.ReadIntervalTimeout != MAXDWORD ||
1091                         port->timeouts.ReadTotalTimeoutMultiplier != 0 ||
1092                         port->timeouts.ReadTotalTimeoutConstant != 0) {
1093                 port->timeouts.ReadIntervalTimeout = MAXDWORD;
1094                 port->timeouts.ReadTotalTimeoutMultiplier = 0;
1095                 port->timeouts.ReadTotalTimeoutConstant = 0;
1096                 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1097                         RETURN_FAIL("SetCommTimeouts() failed");
1098         }
1099
1100         /* Do read. */
1101         if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl) == 0)
1102                 RETURN_FAIL("ReadFile() failed");
1103
1104         /* Get number of bytes read. */
1105         if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE) == 0)
1106                 RETURN_FAIL("GetOverlappedResult() failed");
1107
1108         TRY(restart_wait_if_needed(port, bytes_read));
1109
1110         RETURN_INT(bytes_read);
1111 #else
1112         ssize_t bytes_read;
1113
1114         /* Returns the number of bytes read, or -1 upon failure. */
1115         if ((bytes_read = read(port->fd, buf, count)) < 0) {
1116                 if (errno == EAGAIN)
1117                         /* No bytes available. */
1118                         bytes_read = 0;
1119                 else
1120                         /* This is an actual failure. */
1121                         RETURN_FAIL("read() failed");
1122         }
1123         RETURN_INT(bytes_read);
1124 #endif
1125 }
1126
1127 SP_API enum sp_return sp_input_waiting(struct sp_port *port)
1128 {
1129         TRACE("%p", port);
1130
1131         CHECK_OPEN_PORT();
1132
1133         DEBUG_FMT("Checking input bytes waiting on port %s", port->name);
1134
1135 #ifdef _WIN32
1136         DWORD errors;
1137         COMSTAT comstat;
1138
1139         if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1140                 RETURN_FAIL("ClearCommError() failed");
1141         RETURN_INT(comstat.cbInQue);
1142 #else
1143         int bytes_waiting;
1144         if (ioctl(port->fd, TIOCINQ, &bytes_waiting) < 0)
1145                 RETURN_FAIL("TIOCINQ ioctl failed");
1146         RETURN_INT(bytes_waiting);
1147 #endif
1148 }
1149
1150 SP_API enum sp_return sp_output_waiting(struct sp_port *port)
1151 {
1152         TRACE("%p", port);
1153
1154         CHECK_OPEN_PORT();
1155
1156         DEBUG_FMT("Checking output bytes waiting on port %s", port->name);
1157
1158 #ifdef _WIN32
1159         DWORD errors;
1160         COMSTAT comstat;
1161
1162         if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1163                 RETURN_FAIL("ClearCommError() failed");
1164         RETURN_INT(comstat.cbOutQue);
1165 #else
1166         int bytes_waiting;
1167         if (ioctl(port->fd, TIOCOUTQ, &bytes_waiting) < 0)
1168                 RETURN_FAIL("TIOCOUTQ ioctl failed");
1169         RETURN_INT(bytes_waiting);
1170 #endif
1171 }
1172
1173 SP_API enum sp_return sp_new_event_set(struct sp_event_set **result_ptr)
1174 {
1175         struct sp_event_set *result;
1176
1177         TRACE("%p", result_ptr);
1178
1179         if (!result_ptr)
1180                 RETURN_ERROR(SP_ERR_ARG, "Null result");
1181
1182         *result_ptr = NULL;
1183
1184         if (!(result = malloc(sizeof(struct sp_event_set))))
1185                 RETURN_ERROR(SP_ERR_MEM, "sp_event_set malloc() failed");
1186
1187         memset(result, 0, sizeof(struct sp_event_set));
1188
1189         *result_ptr = result;
1190
1191         RETURN_OK();
1192 }
1193
1194 static enum sp_return add_handle(struct sp_event_set *event_set,
1195                 event_handle handle, enum sp_event mask)
1196 {
1197         void *new_handles;
1198         enum sp_event *new_masks;
1199
1200         TRACE("%p, %d, %d", event_set, handle, mask);
1201
1202         if (!(new_handles = realloc(event_set->handles,
1203                         sizeof(event_handle) * (event_set->count + 1))))
1204                 RETURN_ERROR(SP_ERR_MEM, "Handle array realloc() failed");
1205
1206         event_set->handles = new_handles;
1207
1208         if (!(new_masks = realloc(event_set->masks,
1209                         sizeof(enum sp_event) * (event_set->count + 1))))
1210                 RETURN_ERROR(SP_ERR_MEM, "Mask array realloc() failed");
1211
1212         event_set->masks = new_masks;
1213
1214         ((event_handle *) event_set->handles)[event_set->count] = handle;
1215         event_set->masks[event_set->count] = mask;
1216
1217         event_set->count++;
1218
1219         RETURN_OK();
1220 }
1221
1222 SP_API enum sp_return sp_add_port_events(struct sp_event_set *event_set,
1223         const struct sp_port *port, enum sp_event mask)
1224 {
1225         TRACE("%p, %p, %d", event_set, port, mask);
1226
1227         if (!event_set)
1228                 RETURN_ERROR(SP_ERR_ARG, "Null event set");
1229
1230         if (!port)
1231                 RETURN_ERROR(SP_ERR_ARG, "Null port");
1232
1233         if (mask > (SP_EVENT_RX_READY | SP_EVENT_TX_READY | SP_EVENT_ERROR))
1234                 RETURN_ERROR(SP_ERR_ARG, "Invalid event mask");
1235
1236         if (!mask)
1237                 RETURN_OK();
1238
1239 #ifdef _WIN32
1240         enum sp_event handle_mask;
1241         if ((handle_mask = mask & SP_EVENT_TX_READY))
1242                 TRY(add_handle(event_set, port->write_ovl.hEvent, handle_mask));
1243         if ((handle_mask = mask & (SP_EVENT_RX_READY | SP_EVENT_ERROR)))
1244                 TRY(add_handle(event_set, port->wait_ovl.hEvent, handle_mask));
1245 #else
1246         TRY(add_handle(event_set, port->fd, mask));
1247 #endif
1248
1249         RETURN_OK();
1250 }
1251
1252 SP_API void sp_free_event_set(struct sp_event_set *event_set)
1253 {
1254         TRACE("%p", event_set);
1255
1256         if (!event_set) {
1257                 DEBUG("Null event set");
1258                 RETURN();
1259         }
1260
1261         DEBUG("Freeing event set");
1262
1263         if (event_set->handles)
1264                 free(event_set->handles);
1265         if (event_set->masks)
1266                 free(event_set->masks);
1267
1268         free(event_set);
1269
1270         RETURN();
1271 }
1272
1273 SP_API enum sp_return sp_wait(struct sp_event_set *event_set,
1274                               unsigned int timeout_ms)
1275 {
1276         TRACE("%p, %d", event_set, timeout_ms);
1277
1278         if (!event_set)
1279                 RETURN_ERROR(SP_ERR_ARG, "Null event set");
1280
1281 #ifdef _WIN32
1282         if (WaitForMultipleObjects(event_set->count, event_set->handles, FALSE,
1283                         timeout_ms ? timeout_ms : INFINITE) == WAIT_FAILED)
1284                 RETURN_FAIL("WaitForMultipleObjects() failed");
1285
1286         RETURN_OK();
1287 #else
1288         struct timeval start, delta, now, end = {0, 0};
1289         int started = 0;
1290         int result, timeout_remaining_ms;
1291         struct pollfd *pollfds;
1292         unsigned int i;
1293
1294         if (!(pollfds = malloc(sizeof(struct pollfd) * event_set->count)))
1295                 RETURN_ERROR(SP_ERR_MEM, "pollfds malloc() failed");
1296
1297         for (i = 0; i < event_set->count; i++) {
1298                 pollfds[i].fd = ((int *) event_set->handles)[i];
1299                 pollfds[i].events = 0;
1300                 pollfds[i].revents = 0;
1301                 if (event_set->masks[i] & SP_EVENT_RX_READY)
1302                         pollfds[i].events |= POLLIN;
1303                 if (event_set->masks[i] & SP_EVENT_TX_READY)
1304                         pollfds[i].events |= POLLOUT;
1305                 if (event_set->masks[i] & SP_EVENT_ERROR)
1306                         pollfds[i].events |= POLLERR;
1307         }
1308
1309         if (timeout_ms) {
1310                 /* Get time at start of operation. */
1311                 gettimeofday(&start, NULL);
1312                 /* Define duration of timeout. */
1313                 delta.tv_sec = timeout_ms / 1000;
1314                 delta.tv_usec = (timeout_ms % 1000) * 1000;
1315                 /* Calculate time at which we should give up. */
1316                 timeradd(&start, &delta, &end);
1317         }
1318
1319         /* Loop until an event occurs. */
1320         while (1) {
1321                 /*
1322                  * Check timeout only if we have run poll() at least once,
1323                  * to avoid any issues if a short timeout is reached before
1324                  * poll() is even run.
1325                  */
1326                 if (timeout_ms && started) {
1327                         gettimeofday(&now, NULL);
1328                         if (timercmp(&now, &end, >)) {
1329                                 DEBUG("Wait timed out");
1330                                 break;
1331                         }
1332                         timersub(&end, &now, &delta);
1333                         timeout_remaining_ms = delta.tv_sec * 1000 + delta.tv_usec / 1000;
1334                 }
1335
1336                 result = poll(pollfds, event_set->count, timeout_ms ? timeout_remaining_ms : -1);
1337                 started = 1;
1338
1339                 if (result < 0) {
1340                         if (errno == EINTR) {
1341                                 DEBUG("poll() call was interrupted, repeating");
1342                                 continue;
1343                         } else {
1344                                 free(pollfds);
1345                                 RETURN_FAIL("poll() failed");
1346                         }
1347                 } else if (result == 0) {
1348                         DEBUG("poll() timed out");
1349                         break;
1350                 } else {
1351                         DEBUG("poll() completed");
1352                         break;
1353                 }
1354         }
1355
1356         free(pollfds);
1357         RETURN_OK();
1358 #endif
1359 }
1360
1361 #ifdef USE_TERMIOS_SPEED
1362 static enum sp_return get_baudrate(int fd, int *baudrate)
1363 {
1364         void *data;
1365
1366         TRACE("%d, %p", fd, baudrate);
1367
1368         DEBUG("Getting baud rate");
1369
1370         if (!(data = malloc(get_termios_size())))
1371                 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1372
1373         if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1374                 free(data);
1375                 RETURN_FAIL("Getting termios failed");
1376         }
1377
1378         *baudrate = get_termios_speed(data);
1379
1380         free(data);
1381
1382         RETURN_OK();
1383 }
1384
1385 static enum sp_return set_baudrate(int fd, int baudrate)
1386 {
1387         void *data;
1388
1389         TRACE("%d, %d", fd, baudrate);
1390
1391         DEBUG("Getting baud rate");
1392
1393         if (!(data = malloc(get_termios_size())))
1394                 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1395
1396         if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1397                 free(data);
1398                 RETURN_FAIL("Getting termios failed");
1399         }
1400
1401         DEBUG("Setting baud rate");
1402
1403         set_termios_speed(data, baudrate);
1404
1405         if (ioctl(fd, get_termios_set_ioctl(), data) < 0) {
1406                 free(data);
1407                 RETURN_FAIL("Setting termios failed");
1408         }
1409
1410         free(data);
1411
1412         RETURN_OK();
1413 }
1414 #endif /* USE_TERMIOS_SPEED */
1415
1416 #ifdef USE_TERMIOX
1417 static enum sp_return get_flow(int fd, struct port_data *data)
1418 {
1419         void *termx;
1420
1421         TRACE("%d, %p", fd, data);
1422
1423         DEBUG("Getting advanced flow control");
1424
1425         if (!(termx = malloc(get_termiox_size())))
1426                 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1427
1428         if (ioctl(fd, TCGETX, termx) < 0) {
1429                 free(termx);
1430                 RETURN_FAIL("Getting termiox failed");
1431         }
1432
1433         get_termiox_flow(termx, &data->rts_flow, &data->cts_flow,
1434                         &data->dtr_flow, &data->dsr_flow);
1435
1436         free(termx);
1437
1438         RETURN_OK();
1439 }
1440
1441 static enum sp_return set_flow(int fd, struct port_data *data)
1442 {
1443         void *termx;
1444
1445         TRACE("%d, %p", fd, data);
1446
1447         DEBUG("Getting advanced flow control");
1448
1449         if (!(termx = malloc(get_termiox_size())))
1450                 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1451
1452         if (ioctl(fd, TCGETX, termx) < 0) {
1453                 free(termx);
1454                 RETURN_FAIL("Getting termiox failed");
1455         }
1456
1457         DEBUG("Setting advanced flow control");
1458
1459         set_termiox_flow(termx, data->rts_flow, data->cts_flow,
1460                         data->dtr_flow, data->dsr_flow);
1461
1462         if (ioctl(fd, TCSETX, termx) < 0) {
1463                 free(termx);
1464                 RETURN_FAIL("Setting termiox failed");
1465         }
1466
1467         free(termx);
1468
1469         RETURN_OK();
1470 }
1471 #endif /* USE_TERMIOX */
1472
1473 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
1474         struct sp_port_config *config)
1475 {
1476         unsigned int i;
1477
1478         TRACE("%p, %p, %p", port, data, config);
1479
1480         DEBUG_FMT("Getting configuration for port %s", port->name);
1481
1482 #ifdef _WIN32
1483         if (!GetCommState(port->hdl, &data->dcb))
1484                 RETURN_FAIL("GetCommState() failed");
1485
1486         for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1487                 if (data->dcb.BaudRate == std_baudrates[i].index) {
1488                         config->baudrate = std_baudrates[i].value;
1489                         break;
1490                 }
1491         }
1492
1493         if (i == NUM_STD_BAUDRATES)
1494                 /* BaudRate field can be either an index or a custom baud rate. */
1495                 config->baudrate = data->dcb.BaudRate;
1496
1497         config->bits = data->dcb.ByteSize;
1498
1499         if (data->dcb.fParity)
1500                 switch (data->dcb.Parity) {
1501                 case NOPARITY:
1502                         config->parity = SP_PARITY_NONE;
1503                         break;
1504                 case ODDPARITY:
1505                         config->parity = SP_PARITY_ODD;
1506                         break;
1507                 case EVENPARITY:
1508                         config->parity = SP_PARITY_EVEN;
1509                         break;
1510                 case MARKPARITY:
1511                         config->parity = SP_PARITY_MARK;
1512                         break;
1513                 case SPACEPARITY:
1514                         config->parity = SP_PARITY_SPACE;
1515                         break;
1516                 default:
1517                         config->parity = -1;
1518                 }
1519         else
1520                 config->parity = SP_PARITY_NONE;
1521
1522         switch (data->dcb.StopBits) {
1523         case ONESTOPBIT:
1524                 config->stopbits = 1;
1525                 break;
1526         case TWOSTOPBITS:
1527                 config->stopbits = 2;
1528                 break;
1529         default:
1530                 config->stopbits = -1;
1531         }
1532
1533         switch (data->dcb.fRtsControl) {
1534         case RTS_CONTROL_DISABLE:
1535                 config->rts = SP_RTS_OFF;
1536                 break;
1537         case RTS_CONTROL_ENABLE:
1538                 config->rts = SP_RTS_ON;
1539                 break;
1540         case RTS_CONTROL_HANDSHAKE:
1541                 config->rts = SP_RTS_FLOW_CONTROL;
1542                 break;
1543         default:
1544                 config->rts = -1;
1545         }
1546
1547         config->cts = data->dcb.fOutxCtsFlow ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1548
1549         switch (data->dcb.fDtrControl) {
1550         case DTR_CONTROL_DISABLE:
1551                 config->dtr = SP_DTR_OFF;
1552                 break;
1553         case DTR_CONTROL_ENABLE:
1554                 config->dtr = SP_DTR_ON;
1555                 break;
1556         case DTR_CONTROL_HANDSHAKE:
1557                 config->dtr = SP_DTR_FLOW_CONTROL;
1558                 break;
1559         default:
1560                 config->dtr = -1;
1561         }
1562
1563         config->dsr = data->dcb.fOutxDsrFlow ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1564
1565         if (data->dcb.fInX) {
1566                 if (data->dcb.fOutX)
1567                         config->xon_xoff = SP_XONXOFF_INOUT;
1568                 else
1569                         config->xon_xoff = SP_XONXOFF_IN;
1570         } else {
1571                 if (data->dcb.fOutX)
1572                         config->xon_xoff = SP_XONXOFF_OUT;
1573                 else
1574                         config->xon_xoff = SP_XONXOFF_DISABLED;
1575         }
1576
1577 #else // !_WIN32
1578
1579         if (tcgetattr(port->fd, &data->term) < 0)
1580                 RETURN_FAIL("tcgetattr() failed");
1581
1582         if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0)
1583                 RETURN_FAIL("TIOCMGET ioctl failed");
1584
1585 #ifdef USE_TERMIOX
1586         int ret = get_flow(port->fd, data);
1587
1588         if (ret == SP_ERR_FAIL && errno == EINVAL)
1589                 data->termiox_supported = 0;
1590         else if (ret < 0)
1591                 RETURN_CODEVAL(ret);
1592         else
1593                 data->termiox_supported = 1;
1594 #else
1595         data->termiox_supported = 0;
1596 #endif
1597
1598         for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1599                 if (cfgetispeed(&data->term) == std_baudrates[i].index) {
1600                         config->baudrate = std_baudrates[i].value;
1601                         break;
1602                 }
1603         }
1604
1605         if (i == NUM_STD_BAUDRATES) {
1606 #ifdef __APPLE__
1607                 config->baudrate = (int)data->term.c_ispeed;
1608 #elif defined(USE_TERMIOS_SPEED)
1609                 TRY(get_baudrate(port->fd, &config->baudrate));
1610 #else
1611                 config->baudrate = -1;
1612 #endif
1613         }
1614
1615         switch (data->term.c_cflag & CSIZE) {
1616         case CS8:
1617                 config->bits = 8;
1618                 break;
1619         case CS7:
1620                 config->bits = 7;
1621                 break;
1622         case CS6:
1623                 config->bits = 6;
1624                 break;
1625         case CS5:
1626                 config->bits = 5;
1627                 break;
1628         default:
1629                 config->bits = -1;
1630         }
1631
1632         if (!(data->term.c_cflag & PARENB) && (data->term.c_iflag & IGNPAR))
1633                 config->parity = SP_PARITY_NONE;
1634         else if (!(data->term.c_cflag & PARENB) || (data->term.c_iflag & IGNPAR))
1635                 config->parity = -1;
1636 #ifdef CMSPAR
1637         else if (data->term.c_cflag & CMSPAR)
1638                 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_MARK : SP_PARITY_SPACE;
1639 #endif
1640         else
1641                 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_ODD : SP_PARITY_EVEN;
1642
1643         config->stopbits = (data->term.c_cflag & CSTOPB) ? 2 : 1;
1644
1645         if (data->term.c_cflag & CRTSCTS) {
1646                 config->rts = SP_RTS_FLOW_CONTROL;
1647                 config->cts = SP_CTS_FLOW_CONTROL;
1648         } else {
1649                 if (data->termiox_supported && data->rts_flow)
1650                         config->rts = SP_RTS_FLOW_CONTROL;
1651                 else
1652                         config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
1653
1654                 config->cts = (data->termiox_supported && data->cts_flow) ?
1655                         SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1656         }
1657
1658         if (data->termiox_supported && data->dtr_flow)
1659                 config->dtr = SP_DTR_FLOW_CONTROL;
1660         else
1661                 config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
1662
1663         config->dsr = (data->termiox_supported && data->dsr_flow) ?
1664                 SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1665
1666         if (data->term.c_iflag & IXOFF) {
1667                 if (data->term.c_iflag & IXON)
1668                         config->xon_xoff = SP_XONXOFF_INOUT;
1669                 else
1670                         config->xon_xoff = SP_XONXOFF_IN;
1671         } else {
1672                 if (data->term.c_iflag & IXON)
1673                         config->xon_xoff = SP_XONXOFF_OUT;
1674                 else
1675                         config->xon_xoff = SP_XONXOFF_DISABLED;
1676         }
1677 #endif
1678
1679         RETURN_OK();
1680 }
1681
1682 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
1683         const struct sp_port_config *config)
1684 {
1685         unsigned int i;
1686 #ifdef __APPLE__
1687         BAUD_TYPE baud_nonstd;
1688
1689         baud_nonstd = B0;
1690 #endif
1691 #ifdef USE_TERMIOS_SPEED
1692         int baud_nonstd = 0;
1693 #endif
1694
1695         TRACE("%p, %p, %p", port, data, config);
1696
1697         DEBUG_FMT("Setting configuration for port %s", port->name);
1698
1699 #ifdef _WIN32
1700         if (config->baudrate >= 0) {
1701                 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1702                         if (config->baudrate == std_baudrates[i].value) {
1703                                 data->dcb.BaudRate = std_baudrates[i].index;
1704                                 break;
1705                         }
1706                 }
1707
1708                 if (i == NUM_STD_BAUDRATES)
1709                         data->dcb.BaudRate = config->baudrate;
1710         }
1711
1712         if (config->bits >= 0)
1713                 data->dcb.ByteSize = config->bits;
1714
1715         if (config->parity >= 0) {
1716                 switch (config->parity) {
1717                 case SP_PARITY_NONE:
1718                         data->dcb.Parity = NOPARITY;
1719                         break;
1720                 case SP_PARITY_ODD:
1721                         data->dcb.Parity = ODDPARITY;
1722                         break;
1723                 case SP_PARITY_EVEN:
1724                         data->dcb.Parity = EVENPARITY;
1725                         break;
1726                 case SP_PARITY_MARK:
1727                         data->dcb.Parity = MARKPARITY;
1728                         break;
1729                 case SP_PARITY_SPACE:
1730                         data->dcb.Parity = SPACEPARITY;
1731                         break;
1732                 default:
1733                         RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1734                 }
1735         }
1736
1737         if (config->stopbits >= 0) {
1738                 switch (config->stopbits) {
1739                 /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
1740                 case 1:
1741                         data->dcb.StopBits = ONESTOPBIT;
1742                         break;
1743                 case 2:
1744                         data->dcb.StopBits = TWOSTOPBITS;
1745                         break;
1746                 default:
1747                         RETURN_ERROR(SP_ERR_ARG, "Invalid stop bit setting");
1748                 }
1749         }
1750
1751         if (config->rts >= 0) {
1752                 switch (config->rts) {
1753                 case SP_RTS_OFF:
1754                         data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
1755                         break;
1756                 case SP_RTS_ON:
1757                         data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
1758                         break;
1759                 case SP_RTS_FLOW_CONTROL:
1760                         data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
1761                         break;
1762                 default:
1763                         RETURN_ERROR(SP_ERR_ARG, "Invalid RTS setting");
1764                 }
1765         }
1766
1767         if (config->cts >= 0) {
1768                 switch (config->cts) {
1769                 case SP_CTS_IGNORE:
1770                         data->dcb.fOutxCtsFlow = FALSE;
1771                         break;
1772                 case SP_CTS_FLOW_CONTROL:
1773                         data->dcb.fOutxCtsFlow = TRUE;
1774                         break;
1775                 default:
1776                         RETURN_ERROR(SP_ERR_ARG, "Invalid CTS setting");
1777                 }
1778         }
1779
1780         if (config->dtr >= 0) {
1781                 switch (config->dtr) {
1782                 case SP_DTR_OFF:
1783                         data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
1784                         break;
1785                 case SP_DTR_ON:
1786                         data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
1787                         break;
1788                 case SP_DTR_FLOW_CONTROL:
1789                         data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
1790                         break;
1791                 default:
1792                         RETURN_ERROR(SP_ERR_ARG, "Invalid DTR setting");
1793                 }
1794         }
1795
1796         if (config->dsr >= 0) {
1797                 switch (config->dsr) {
1798                 case SP_DSR_IGNORE:
1799                         data->dcb.fOutxDsrFlow = FALSE;
1800                         break;
1801                 case SP_DSR_FLOW_CONTROL:
1802                         data->dcb.fOutxDsrFlow = TRUE;
1803                         break;
1804                 default:
1805                         RETURN_ERROR(SP_ERR_ARG, "Invalid DSR setting");
1806                 }
1807         }
1808
1809         if (config->xon_xoff >= 0) {
1810                 switch (config->xon_xoff) {
1811                 case SP_XONXOFF_DISABLED:
1812                         data->dcb.fInX = FALSE;
1813                         data->dcb.fOutX = FALSE;
1814                         break;
1815                 case SP_XONXOFF_IN:
1816                         data->dcb.fInX = TRUE;
1817                         data->dcb.fOutX = FALSE;
1818                         break;
1819                 case SP_XONXOFF_OUT:
1820                         data->dcb.fInX = FALSE;
1821                         data->dcb.fOutX = TRUE;
1822                         break;
1823                 case SP_XONXOFF_INOUT:
1824                         data->dcb.fInX = TRUE;
1825                         data->dcb.fOutX = TRUE;
1826                         break;
1827                 default:
1828                         RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
1829                 }
1830         }
1831
1832         if (!SetCommState(port->hdl, &data->dcb))
1833                 RETURN_FAIL("SetCommState() failed");
1834
1835 #else /* !_WIN32 */
1836
1837         int controlbits;
1838
1839         if (config->baudrate >= 0) {
1840                 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1841                         if (config->baudrate == std_baudrates[i].value) {
1842                                 if (cfsetospeed(&data->term, std_baudrates[i].index) < 0)
1843                                         RETURN_FAIL("cfsetospeed() failed");
1844
1845                                 if (cfsetispeed(&data->term, std_baudrates[i].index) < 0)
1846                                         RETURN_FAIL("cfsetispeed() failed");
1847                                 break;
1848                         }
1849                 }
1850
1851                 /* Non-standard baud rate */
1852                 if (i == NUM_STD_BAUDRATES) {
1853 #ifdef __APPLE__
1854                         /* Set "dummy" baud rate. */
1855                         if (cfsetspeed(&data->term, B9600) < 0)
1856                                 RETURN_FAIL("cfsetspeed() failed");
1857                         baud_nonstd = config->baudrate;
1858 #elif defined(USE_TERMIOS_SPEED)
1859                         baud_nonstd = 1;
1860 #else
1861                         RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported");
1862 #endif
1863                 }
1864         }
1865
1866         if (config->bits >= 0) {
1867                 data->term.c_cflag &= ~CSIZE;
1868                 switch (config->bits) {
1869                 case 8:
1870                         data->term.c_cflag |= CS8;
1871                         break;
1872                 case 7:
1873                         data->term.c_cflag |= CS7;
1874                         break;
1875                 case 6:
1876                         data->term.c_cflag |= CS6;
1877                         break;
1878                 case 5:
1879                         data->term.c_cflag |= CS5;
1880                         break;
1881                 default:
1882                         RETURN_ERROR(SP_ERR_ARG, "Invalid data bits setting");
1883                 }
1884         }
1885
1886         if (config->parity >= 0) {
1887                 data->term.c_iflag &= ~IGNPAR;
1888                 data->term.c_cflag &= ~(PARENB | PARODD);
1889 #ifdef CMSPAR
1890                 data->term.c_cflag &= ~CMSPAR;
1891 #endif
1892                 switch (config->parity) {
1893                 case SP_PARITY_NONE:
1894                         data->term.c_iflag |= IGNPAR;
1895                         break;
1896                 case SP_PARITY_EVEN:
1897                         data->term.c_cflag |= PARENB;
1898                         break;
1899                 case SP_PARITY_ODD:
1900                         data->term.c_cflag |= PARENB | PARODD;
1901                         break;
1902 #ifdef CMSPAR
1903                 case SP_PARITY_MARK:
1904                         data->term.c_cflag |= PARENB | PARODD;
1905                         data->term.c_cflag |= CMSPAR;
1906                         break;
1907                 case SP_PARITY_SPACE:
1908                         data->term.c_cflag |= PARENB;
1909                         data->term.c_cflag |= CMSPAR;
1910                         break;
1911 #else
1912                 case SP_PARITY_MARK:
1913                 case SP_PARITY_SPACE:
1914                         RETURN_ERROR(SP_ERR_SUPP, "Mark/space parity not supported");
1915 #endif
1916                 default:
1917                         RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1918                 }
1919         }
1920
1921         if (config->stopbits >= 0) {
1922                 data->term.c_cflag &= ~CSTOPB;
1923                 switch (config->stopbits) {
1924                 case 1:
1925                         data->term.c_cflag &= ~CSTOPB;
1926                         break;
1927                 case 2:
1928                         data->term.c_cflag |= CSTOPB;
1929                         break;
1930                 default:
1931                         RETURN_ERROR(SP_ERR_ARG, "Invalid stop bits setting");
1932                 }
1933         }
1934
1935         if (config->rts >= 0 || config->cts >= 0) {
1936                 if (data->termiox_supported) {
1937                         data->rts_flow = data->cts_flow = 0;
1938                         switch (config->rts) {
1939                         case SP_RTS_OFF:
1940                         case SP_RTS_ON:
1941                                 controlbits = TIOCM_RTS;
1942                                 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
1943                                         RETURN_FAIL("Setting RTS signal level failed");
1944                                 break;
1945                         case SP_RTS_FLOW_CONTROL:
1946                                 data->rts_flow = 1;
1947                                 break;
1948                         default:
1949                                 break;
1950                         }
1951                         if (config->cts == SP_CTS_FLOW_CONTROL)
1952                                 data->cts_flow = 1;
1953
1954                         if (data->rts_flow && data->cts_flow)
1955                                 data->term.c_iflag |= CRTSCTS;
1956                         else
1957                                 data->term.c_iflag &= ~CRTSCTS;
1958                 } else {
1959                         /* Asymmetric use of RTS/CTS not supported. */
1960                         if (data->term.c_iflag & CRTSCTS) {
1961                                 /* Flow control can only be disabled for both RTS & CTS together. */
1962                                 if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) {
1963                                         if (config->cts != SP_CTS_IGNORE)
1964                                                 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
1965                                 }
1966                                 if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) {
1967                                         if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL)
1968                                                 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
1969                                 }
1970                         } else {
1971                                 /* Flow control can only be enabled for both RTS & CTS together. */
1972                                 if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) ||
1973                                         ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL)))
1974                                         RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be enabled together");
1975                         }
1976
1977                         if (config->rts >= 0) {
1978                                 if (config->rts == SP_RTS_FLOW_CONTROL) {
1979                                         data->term.c_iflag |= CRTSCTS;
1980                                 } else {
1981                                         controlbits = TIOCM_RTS;
1982                                         if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
1983                                                         &controlbits) < 0)
1984                                                 RETURN_FAIL("Setting RTS signal level failed");
1985                                 }
1986                         }
1987                 }
1988         }
1989
1990         if (config->dtr >= 0 || config->dsr >= 0) {
1991                 if (data->termiox_supported) {
1992                         data->dtr_flow = data->dsr_flow = 0;
1993                         switch (config->dtr) {
1994                         case SP_DTR_OFF:
1995                         case SP_DTR_ON:
1996                                 controlbits = TIOCM_DTR;
1997                                 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
1998                                         RETURN_FAIL("Setting DTR signal level failed");
1999                                 break;
2000                         case SP_DTR_FLOW_CONTROL:
2001                                 data->dtr_flow = 1;
2002                                 break;
2003                         default:
2004                                 break;
2005                         }
2006                         if (config->dsr == SP_DSR_FLOW_CONTROL)
2007                                 data->dsr_flow = 1;
2008                 } else {
2009                         /* DTR/DSR flow control not supported. */
2010                         if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
2011                                 RETURN_ERROR(SP_ERR_SUPP, "DTR/DSR flow control not supported");
2012
2013                         if (config->dtr >= 0) {
2014                                 controlbits = TIOCM_DTR;
2015                                 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
2016                                                 &controlbits) < 0)
2017                                         RETURN_FAIL("Setting DTR signal level failed");
2018                         }
2019                 }
2020         }
2021
2022         if (config->xon_xoff >= 0) {
2023                 data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
2024                 switch (config->xon_xoff) {
2025                 case SP_XONXOFF_DISABLED:
2026                         break;
2027                 case SP_XONXOFF_IN:
2028                         data->term.c_iflag |= IXOFF;
2029                         break;
2030                 case SP_XONXOFF_OUT:
2031                         data->term.c_iflag |= IXON | IXANY;
2032                         break;
2033                 case SP_XONXOFF_INOUT:
2034                         data->term.c_iflag |= IXON | IXOFF | IXANY;
2035                         break;
2036                 default:
2037                         RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
2038                 }
2039         }
2040
2041         if (tcsetattr(port->fd, TCSANOW, &data->term) < 0)
2042                 RETURN_FAIL("tcsetattr() failed");
2043
2044 #ifdef __APPLE__
2045         if (baud_nonstd != B0) {
2046                 if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1)
2047                         RETURN_FAIL("IOSSIOSPEED ioctl failed");
2048                 /*
2049                  * Set baud rates in data->term to correct, but incompatible
2050                  * with tcsetattr() value, same as delivered by tcgetattr().
2051                  */
2052                 if (cfsetspeed(&data->term, baud_nonstd) < 0)
2053                         RETURN_FAIL("cfsetspeed() failed");
2054         }
2055 #elif defined(__linux__)
2056 #ifdef USE_TERMIOS_SPEED
2057         if (baud_nonstd)
2058                 TRY(set_baudrate(port->fd, config->baudrate));
2059 #endif
2060 #ifdef USE_TERMIOX
2061         if (data->termiox_supported)
2062                 TRY(set_flow(port->fd, data));
2063 #endif
2064 #endif
2065
2066 #endif /* !_WIN32 */
2067
2068         RETURN_OK();
2069 }
2070
2071 SP_API enum sp_return sp_new_config(struct sp_port_config **config_ptr)
2072 {
2073         struct sp_port_config *config;
2074
2075         TRACE("%p", config_ptr);
2076
2077         if (!config_ptr)
2078                 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2079
2080         *config_ptr = NULL;
2081
2082         if (!(config = malloc(sizeof(struct sp_port_config))))
2083                 RETURN_ERROR(SP_ERR_MEM, "Config malloc failed");
2084
2085         config->baudrate = -1;
2086         config->bits = -1;
2087         config->parity = -1;
2088         config->stopbits = -1;
2089         config->rts = -1;
2090         config->cts = -1;
2091         config->dtr = -1;
2092         config->dsr = -1;
2093
2094         *config_ptr = config;
2095
2096         RETURN_OK();
2097 }
2098
2099 SP_API void sp_free_config(struct sp_port_config *config)
2100 {
2101         TRACE("%p", config);
2102
2103         if (!config)
2104                 DEBUG("Null config");
2105         else
2106                 free(config);
2107
2108         RETURN();
2109 }
2110
2111 SP_API enum sp_return sp_get_config(struct sp_port *port,
2112                                     struct sp_port_config *config)
2113 {
2114         struct port_data data;
2115
2116         TRACE("%p, %p", port, config);
2117
2118         CHECK_OPEN_PORT();
2119
2120         if (!config)
2121                 RETURN_ERROR(SP_ERR_ARG, "Null config");
2122
2123         TRY(get_config(port, &data, config));
2124
2125         RETURN_OK();
2126 }
2127
2128 SP_API enum sp_return sp_set_config(struct sp_port *port,
2129                                     const struct sp_port_config *config)
2130 {
2131         struct port_data data;
2132         struct sp_port_config prev_config;
2133
2134         TRACE("%p, %p", port, config);
2135
2136         CHECK_OPEN_PORT();
2137
2138         if (!config)
2139                 RETURN_ERROR(SP_ERR_ARG, "Null config");
2140
2141         TRY(get_config(port, &data, &prev_config));
2142         TRY(set_config(port, &data, config));
2143
2144         RETURN_OK();
2145 }
2146
2147 #define CREATE_ACCESSORS(x, type) \
2148 SP_API enum sp_return sp_set_##x(struct sp_port *port, type x) { \
2149         struct port_data data; \
2150         struct sp_port_config config; \
2151         TRACE("%p, %d", port, x); \
2152         CHECK_OPEN_PORT(); \
2153         TRY(get_config(port, &data, &config)); \
2154         config.x = x; \
2155         TRY(set_config(port, &data, &config)); \
2156         RETURN_OK(); \
2157 } \
2158 SP_API enum sp_return sp_get_config_##x(const struct sp_port_config *config, \
2159                                         type *x) { \
2160         TRACE("%p, %p", config, x); \
2161         if (!x) \
2162                 RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); \
2163         if (!config) \
2164                 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2165         *x = config->x; \
2166         RETURN_OK(); \
2167 } \
2168 SP_API enum sp_return sp_set_config_##x(struct sp_port_config *config, \
2169                                         type x) { \
2170         TRACE("%p, %d", config, x); \
2171         if (!config) \
2172                 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2173         config->x = x; \
2174         RETURN_OK(); \
2175 }
2176
2177 CREATE_ACCESSORS(baudrate, int)
2178 CREATE_ACCESSORS(bits, int)
2179 CREATE_ACCESSORS(parity, enum sp_parity)
2180 CREATE_ACCESSORS(stopbits, int)
2181 CREATE_ACCESSORS(rts, enum sp_rts)
2182 CREATE_ACCESSORS(cts, enum sp_cts)
2183 CREATE_ACCESSORS(dtr, enum sp_dtr)
2184 CREATE_ACCESSORS(dsr, enum sp_dsr)
2185 CREATE_ACCESSORS(xon_xoff, enum sp_xonxoff)
2186
2187 SP_API enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config,
2188                                                 enum sp_flowcontrol flowcontrol)
2189 {
2190         if (!config)
2191                 RETURN_ERROR(SP_ERR_ARG, "Null configuration");
2192
2193         if (flowcontrol > SP_FLOWCONTROL_DTRDSR)
2194                 RETURN_ERROR(SP_ERR_ARG, "Invalid flow control setting");
2195
2196         if (flowcontrol == SP_FLOWCONTROL_XONXOFF)
2197                 config->xon_xoff = SP_XONXOFF_INOUT;
2198         else
2199                 config->xon_xoff = SP_XONXOFF_DISABLED;
2200
2201         if (flowcontrol == SP_FLOWCONTROL_RTSCTS) {
2202                 config->rts = SP_RTS_FLOW_CONTROL;
2203                 config->cts = SP_CTS_FLOW_CONTROL;
2204         } else {
2205                 if (config->rts == SP_RTS_FLOW_CONTROL)
2206                         config->rts = SP_RTS_ON;
2207                 config->cts = SP_CTS_IGNORE;
2208         }
2209
2210         if (flowcontrol == SP_FLOWCONTROL_DTRDSR) {
2211                 config->dtr = SP_DTR_FLOW_CONTROL;
2212                 config->dsr = SP_DSR_FLOW_CONTROL;
2213         } else {
2214                 if (config->dtr == SP_DTR_FLOW_CONTROL)
2215                         config->dtr = SP_DTR_ON;
2216                 config->dsr = SP_DSR_IGNORE;
2217         }
2218
2219         RETURN_OK();
2220 }
2221
2222 SP_API enum sp_return sp_set_flowcontrol(struct sp_port *port,
2223                                          enum sp_flowcontrol flowcontrol)
2224 {
2225         struct port_data data;
2226         struct sp_port_config config;
2227
2228         TRACE("%p, %d", port, flowcontrol);
2229
2230         CHECK_OPEN_PORT();
2231
2232         TRY(get_config(port, &data, &config));
2233
2234         TRY(sp_set_config_flowcontrol(&config, flowcontrol));
2235
2236         TRY(set_config(port, &data, &config));
2237
2238         RETURN_OK();
2239 }
2240
2241 SP_API enum sp_return sp_get_signals(struct sp_port *port,
2242                                      enum sp_signal *signals)
2243 {
2244         TRACE("%p, %p", port, signals);
2245
2246         CHECK_OPEN_PORT();
2247
2248         if (!signals)
2249                 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2250
2251         DEBUG_FMT("Getting control signals for port %s", port->name);
2252
2253         *signals = 0;
2254 #ifdef _WIN32
2255         DWORD bits;
2256         if (GetCommModemStatus(port->hdl, &bits) == 0)
2257                 RETURN_FAIL("GetCommModemStatus() failed");
2258         if (bits & MS_CTS_ON)
2259                 *signals |= SP_SIG_CTS;
2260         if (bits & MS_DSR_ON)
2261                 *signals |= SP_SIG_DSR;
2262         if (bits & MS_RLSD_ON)
2263                 *signals |= SP_SIG_DCD;
2264         if (bits & MS_RING_ON)
2265                 *signals |= SP_SIG_RI;
2266 #else
2267         int bits;
2268         if (ioctl(port->fd, TIOCMGET, &bits) < 0)
2269                 RETURN_FAIL("TIOCMGET ioctl failed");
2270         if (bits & TIOCM_CTS)
2271                 *signals |= SP_SIG_CTS;
2272         if (bits & TIOCM_DSR)
2273                 *signals |= SP_SIG_DSR;
2274         if (bits & TIOCM_CAR)
2275                 *signals |= SP_SIG_DCD;
2276         if (bits & TIOCM_RNG)
2277                 *signals |= SP_SIG_RI;
2278 #endif
2279         RETURN_OK();
2280 }
2281
2282 SP_API enum sp_return sp_start_break(struct sp_port *port)
2283 {
2284         TRACE("%p", port);
2285
2286         CHECK_OPEN_PORT();
2287 #ifdef _WIN32
2288         if (SetCommBreak(port->hdl) == 0)
2289                 RETURN_FAIL("SetCommBreak() failed");
2290 #else
2291         if (ioctl(port->fd, TIOCSBRK, 1) < 0)
2292                 RETURN_FAIL("TIOCSBRK ioctl failed");
2293 #endif
2294
2295         RETURN_OK();
2296 }
2297
2298 SP_API enum sp_return sp_end_break(struct sp_port *port)
2299 {
2300         TRACE("%p", port);
2301
2302         CHECK_OPEN_PORT();
2303 #ifdef _WIN32
2304         if (ClearCommBreak(port->hdl) == 0)
2305                 RETURN_FAIL("ClearCommBreak() failed");
2306 #else
2307         if (ioctl(port->fd, TIOCCBRK, 1) < 0)
2308                 RETURN_FAIL("TIOCCBRK ioctl failed");
2309 #endif
2310
2311         RETURN_OK();
2312 }
2313
2314 SP_API int sp_last_error_code(void)
2315 {
2316         TRACE_VOID();
2317 #ifdef _WIN32
2318         RETURN_INT(GetLastError());
2319 #else
2320         RETURN_INT(errno);
2321 #endif
2322 }
2323
2324 SP_API char *sp_last_error_message(void)
2325 {
2326         TRACE_VOID();
2327
2328 #ifdef _WIN32
2329         TCHAR *message;
2330         DWORD error = GetLastError();
2331
2332         DWORD length = FormatMessage(
2333                 FORMAT_MESSAGE_ALLOCATE_BUFFER |
2334                 FORMAT_MESSAGE_FROM_SYSTEM |
2335                 FORMAT_MESSAGE_IGNORE_INSERTS,
2336                 NULL,
2337                 error,
2338                 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
2339                 (LPTSTR) &message,
2340                 0, NULL );
2341
2342         if (length >= 2 && message[length - 2] == '\r')
2343                 message[length - 2] = '\0';
2344
2345         RETURN_STRING(message);
2346 #else
2347         RETURN_STRING(strerror(errno));
2348 #endif
2349 }
2350
2351 SP_API void sp_free_error_message(char *message)
2352 {
2353         TRACE("%s", message);
2354
2355 #ifdef _WIN32
2356         LocalFree(message);
2357 #else
2358         (void)message;
2359 #endif
2360
2361         RETURN();
2362 }
2363
2364 SP_API void sp_set_debug_handler(void (*handler)(const char *format, ...))
2365 {
2366         TRACE("%p", handler);
2367
2368         sp_debug_handler = handler;
2369
2370         RETURN();
2371 }
2372
2373 SP_API void sp_default_debug_handler(const char *format, ...)
2374 {
2375         va_list args;
2376         va_start(args, format);
2377         if (getenv("LIBSERIALPORT_DEBUG")) {
2378                 fputs("sp: ", stderr);
2379                 vfprintf(stderr, format, args);
2380         }
2381         va_end(args);
2382 }
2383
2384 SP_API int sp_get_major_package_version(void)
2385 {
2386         return SP_PACKAGE_VERSION_MAJOR;
2387 }
2388
2389 SP_API int sp_get_minor_package_version(void)
2390 {
2391         return SP_PACKAGE_VERSION_MINOR;
2392 }
2393
2394 SP_API int sp_get_micro_package_version(void)
2395 {
2396         return SP_PACKAGE_VERSION_MICRO;
2397 }
2398
2399 SP_API const char *sp_get_package_version_string(void)
2400 {
2401         return SP_PACKAGE_VERSION_STRING;
2402 }
2403
2404 SP_API int sp_get_current_lib_version(void)
2405 {
2406         return SP_LIB_VERSION_CURRENT;
2407 }
2408
2409 SP_API int sp_get_revision_lib_version(void)
2410 {
2411         return SP_LIB_VERSION_REVISION;
2412 }
2413
2414 SP_API int sp_get_age_lib_version(void)
2415 {
2416         return SP_LIB_VERSION_AGE;
2417 }
2418
2419 SP_API const char *sp_get_lib_version_string(void)
2420 {
2421         return SP_LIB_VERSION_STRING;
2422 }
2423
2424 /** @} */