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) == 0) {
 762                 if (GetLastError() == ERROR_IO_PENDING) {
 763                         DEBUG("Waiting for write to complete");
 764                         GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE);
 765                         DEBUG_FMT("Write completed, %d/%d bytes written", bytes_written, count);
 766                         RETURN_INT(bytes_written);
 767                 } else {
 768                         RETURN_FAIL("WriteFile() failed");
 769                 }
 770         } else {
 771                 DEBUG("Write completed immediately");
 772                 RETURN_INT(count);
 773         }
 774 #else
 775         size_t bytes_written = 0;
 776         unsigned char *ptr = (unsigned char *) buf;
 777         struct timeval start, delta, now, end = {0, 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         /* Loop until we have written the requested number of bytes. */
 792         while (bytes_written < count) {
 793                 /* Wait until space is available. */
 794                 FD_ZERO(&fds);
 795                 FD_SET(port->fd, &fds);
 796                 if (timeout_ms) {
 797                         gettimeofday(&now, NULL);
 798                         if (timercmp(&now, &end, >)) {
 799                                 DEBUG("Write timed out");
 800                                 RETURN_INT(bytes_written);
 801                         }
 802                         timersub(&end, &now, &delta);
 803                 }
 804                 result = select(port->fd + 1, NULL, &fds, NULL, timeout_ms ? &delta : NULL);
 805                 if (result < 0) {
 806                         if (errno == EINTR) {
 807                                 DEBUG("select() call was interrupted, repeating");
 808                                 continue;
 809                         } else {
 810                                 RETURN_FAIL("select() failed");
 811                         }
 812                 } else if (result == 0) {
 813                         DEBUG("Write timed out");
 814                         RETURN_INT(bytes_written);
 815                 }
 816
 817                 /* Do write. */
 818                 result = write(port->fd, ptr, count - bytes_written);
 819
 820                 if (result < 0) {
 821                         if (errno == EAGAIN)
 822                                 /* This shouldn't happen because we did a select() first, but handle anyway. */
 823                                 continue;
 824                         else
 825                                 /* This is an actual failure. */
 826                                 RETURN_FAIL("write() failed");
 827                 }
 828
 829                 bytes_written += result;
 830                 ptr += result;
 831         }
 832
 833         RETURN_INT(bytes_written);
 834 #endif
 835 }
 836
 837 SP_API enum sp_return sp_nonblocking_write(struct sp_port *port,
 838                                            const void *buf, size_t count)
 839 {
 840         TRACE("%p, %p, %d", port, buf, count);
 841
 842         CHECK_OPEN_PORT();
 843
 844         if (!buf)
 845                 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
 846
 847         DEBUG_FMT("Writing up to %d bytes to port %s", count, port->name);
 848
 849         if (count == 0)
 850                 RETURN_INT(0);
 851
 852 #ifdef _WIN32
 853         DWORD written = 0;
 854         BYTE *ptr = (BYTE *) buf;
 855
 856         /* Check whether previous write is complete. */
 857         if (port->writing) {
 858                 if (HasOverlappedIoCompleted(&port->write_ovl)) {
 859                         DEBUG("Previous write completed");
 860                         port->writing = 0;
 861                 } else {
 862                         DEBUG("Previous write not complete");
 863                         /* Can't take a new write until the previous one finishes. */
 864                         RETURN_INT(0);
 865                 }
 866         }
 867
 868         /* Set timeout. */
 869         if (port->timeouts.WriteTotalTimeoutConstant != 0) {
 870                 port->timeouts.WriteTotalTimeoutConstant = 0;
 871                 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
 872                         RETURN_FAIL("SetCommTimeouts() failed");
 873         }
 874
 875         /*
 876          * Keep writing data until the OS has to actually start an async IO
 877          * for it. At that point we know the buffer is full.
 878          */
 879         while (written < count) {
 880                 /* Copy first byte of user buffer. */
 881                 port->pending_byte = *ptr++;
 882
 883                 /* Start asynchronous write. */
 884                 if (WriteFile(port->hdl, &port->pending_byte, 1, NULL, &port->write_ovl) == 0) {
 885                         if (GetLastError() == ERROR_IO_PENDING) {
 886                                 if (HasOverlappedIoCompleted(&port->write_ovl)) {
 887                                         DEBUG("Asynchronous write completed immediately");
 888                                         port->writing = 0;
 889                                         written++;
 890                                         continue;
 891                                 } else {
 892                                         DEBUG("Asynchronous write running");
 893                                         port->writing = 1;
 894                                         RETURN_INT(++written);
 895                                 }
 896                         } else {
 897                                 /* Actual failure of some kind. */
 898                                 RETURN_FAIL("WriteFile() failed");
 899                         }
 900                 } else {
 901                         DEBUG("Single byte written immediately");
 902                         written++;
 903                 }
 904         }
 905
 906         DEBUG("All bytes written immediately");
 907
 908         RETURN_INT(written);
 909 #else
 910         /* Returns the number of bytes written, or -1 upon failure. */
 911         ssize_t written = write(port->fd, buf, count);
 912
 913         if (written < 0)
 914                 RETURN_FAIL("write() failed");
 915         else
 916                 RETURN_INT(written);
 917 #endif
 918 }
 919
 920 #ifdef _WIN32
 921 /* Restart wait operation if buffer was emptied. */
 922 static enum sp_return restart_wait_if_needed(struct sp_port *port, unsigned int bytes_read)
 923 {
 924         int ret, bytes_remaining;
 925
 926         if (bytes_read == 0)
 927                 RETURN_OK();
 928
 929         ret = sp_input_waiting(port);
 930
 931         if (ret < 0)
 932                 RETURN_CODEVAL(ret);
 933
 934         bytes_remaining = ret;
 935
 936         if (bytes_remaining == 0)
 937                 TRY(restart_wait(port));
 938
 939         RETURN_OK();
 940 }
 941 #endif
 942
 943 SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
 944                                        size_t count, unsigned int timeout_ms)
 945 {
 946         TRACE("%p, %p, %d, %d", port, buf, count, timeout_ms);
 947
 948         CHECK_OPEN_PORT();
 949
 950         if (!buf)
 951                 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
 952
 953         if (timeout_ms)
 954                 DEBUG_FMT("Reading %d bytes from port %s, timeout %d ms",
 955                         count, port->name, timeout_ms);
 956         else
 957                 DEBUG_FMT("Reading %d bytes from port %s, no timeout",
 958                         count, port->name);
 959
 960         if (count == 0)
 961                 RETURN_INT(0);
 962
 963 #ifdef _WIN32
 964         DWORD bytes_read = 0;
 965
 966         /* Set timeout. */
 967         if (port->timeouts.ReadIntervalTimeout != 0 ||
 968                         port->timeouts.ReadTotalTimeoutConstant != timeout_ms) {
 969                 port->timeouts.ReadIntervalTimeout = 0;
 970                 port->timeouts.ReadTotalTimeoutConstant = timeout_ms;
 971                 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
 972                         RETURN_FAIL("SetCommTimeouts() failed");
 973         }
 974
 975         /* Start read. */
 976         if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl) == 0) {
 977                 if (GetLastError() == ERROR_IO_PENDING) {
 978                         DEBUG("Waiting for read to complete");
 979                         GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE);
 980                         DEBUG_FMT("Read completed, %d/%d bytes read", bytes_read, count);
 981                 } else {
 982                         RETURN_FAIL("ReadFile() failed");
 983                 }
 984         } else {
 985                 DEBUG("Read completed immediately");
 986                 bytes_read = count;
 987         }
 988
 989         TRY(restart_wait_if_needed(port, bytes_read));
 990
 991         RETURN_INT(bytes_read);
 992
 993 #else
 994         size_t bytes_read = 0;
 995         unsigned char *ptr = (unsigned char *) buf;
 996         struct timeval start, delta, now, end = {0, 0};
 997         fd_set fds;
 998         int result;
 999
1000         if (timeout_ms) {
1001                 /* Get time at start of operation. */
1002                 gettimeofday(&start, NULL);
1003                 /* Define duration of timeout. */
1004                 delta.tv_sec = timeout_ms / 1000;
1005                 delta.tv_usec = (timeout_ms % 1000) * 1000;
1006                 /* Calculate time at which we should give up. */
1007                 timeradd(&start, &delta, &end);
1008         }
1009
1010         /* Loop until we have the requested number of bytes. */
1011         while (bytes_read < count) {
1012                 /* Wait until data is available. */
1013                 FD_ZERO(&fds);
1014                 FD_SET(port->fd, &fds);
1015                 if (timeout_ms) {
1016                         gettimeofday(&now, NULL);
1017                         if (timercmp(&now, &end, >))
1018                                 /* Timeout has expired. */
1019                                 RETURN_INT(bytes_read);
1020                         timersub(&end, &now, &delta);
1021                 }
1022                 result = select(port->fd + 1, &fds, NULL, NULL, timeout_ms ? &delta : NULL);
1023                 if (result < 0) {
1024                         if (errno == EINTR) {
1025                                 DEBUG("select() call was interrupted, repeating");
1026                                 continue;
1027                         } else {
1028                                 RETURN_FAIL("select() failed");
1029                         }
1030                 } else if (result == 0) {
1031                         DEBUG("Read timed out");
1032                         RETURN_INT(bytes_read);
1033                 }
1034
1035                 /* Do read. */
1036                 result = read(port->fd, ptr, count - bytes_read);
1037
1038                 if (result < 0) {
1039                         if (errno == EAGAIN)
1040                                 /* This shouldn't happen because we did a select() first, but handle anyway. */
1041                                 continue;
1042                         else
1043                                 /* This is an actual failure. */
1044                                 RETURN_FAIL("read() failed");
1045                 }
1046
1047                 bytes_read += result;
1048                 ptr += result;
1049         }
1050
1051         RETURN_INT(bytes_read);
1052 #endif
1053 }
1054
1055 SP_API enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf,
1056                                           size_t count)
1057 {
1058         TRACE("%p, %p, %d", port, buf, count);
1059
1060         CHECK_OPEN_PORT();
1061
1062         if (!buf)
1063                 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
1064
1065         DEBUG_FMT("Reading up to %d bytes from port %s", count, port->name);
1066
1067 #ifdef _WIN32
1068         DWORD bytes_read;
1069
1070         /* Set timeout. */
1071         if (port->timeouts.ReadIntervalTimeout != MAXDWORD ||
1072                         port->timeouts.ReadTotalTimeoutConstant != 0) {
1073                 port->timeouts.ReadIntervalTimeout = MAXDWORD;
1074                 port->timeouts.ReadTotalTimeoutConstant = 0;
1075                 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1076                         RETURN_FAIL("SetCommTimeouts() failed");
1077         }
1078
1079         /* Do read. */
1080         if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl) == 0)
1081                 RETURN_FAIL("ReadFile() failed");
1082
1083         /* Get number of bytes read. */
1084         if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE) == 0)
1085                 RETURN_FAIL("GetOverlappedResult() failed");
1086
1087         TRY(restart_wait_if_needed(port, bytes_read));
1088
1089         RETURN_INT(bytes_read);
1090 #else
1091         ssize_t bytes_read;
1092
1093         /* Returns the number of bytes read, or -1 upon failure. */
1094         if ((bytes_read = read(port->fd, buf, count)) < 0) {
1095                 if (errno == EAGAIN)
1096                         /* No bytes available. */
1097                         bytes_read = 0;
1098                 else
1099                         /* This is an actual failure. */
1100                         RETURN_FAIL("read() failed");
1101         }
1102         RETURN_INT(bytes_read);
1103 #endif
1104 }
1105
1106 SP_API enum sp_return sp_input_waiting(struct sp_port *port)
1107 {
1108         TRACE("%p", port);
1109
1110         CHECK_OPEN_PORT();
1111
1112         DEBUG_FMT("Checking input bytes waiting on port %s", port->name);
1113
1114 #ifdef _WIN32
1115         DWORD errors;
1116         COMSTAT comstat;
1117
1118         if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1119                 RETURN_FAIL("ClearCommError() failed");
1120         RETURN_INT(comstat.cbInQue);
1121 #else
1122         int bytes_waiting;
1123         if (ioctl(port->fd, TIOCINQ, &bytes_waiting) < 0)
1124                 RETURN_FAIL("TIOCINQ ioctl failed");
1125         RETURN_INT(bytes_waiting);
1126 #endif
1127 }
1128
1129 SP_API enum sp_return sp_output_waiting(struct sp_port *port)
1130 {
1131         TRACE("%p", port);
1132
1133         CHECK_OPEN_PORT();
1134
1135         DEBUG_FMT("Checking output bytes waiting on port %s", port->name);
1136
1137 #ifdef _WIN32
1138         DWORD errors;
1139         COMSTAT comstat;
1140
1141         if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1142                 RETURN_FAIL("ClearCommError() failed");
1143         RETURN_INT(comstat.cbOutQue);
1144 #else
1145         int bytes_waiting;
1146         if (ioctl(port->fd, TIOCOUTQ, &bytes_waiting) < 0)
1147                 RETURN_FAIL("TIOCOUTQ ioctl failed");
1148         RETURN_INT(bytes_waiting);
1149 #endif
1150 }
1151
1152 SP_API enum sp_return sp_new_event_set(struct sp_event_set **result_ptr)
1153 {
1154         struct sp_event_set *result;
1155
1156         TRACE("%p", result_ptr);
1157
1158         if (!result_ptr)
1159                 RETURN_ERROR(SP_ERR_ARG, "Null result");
1160
1161         *result_ptr = NULL;
1162
1163         if (!(result = malloc(sizeof(struct sp_event_set))))
1164                 RETURN_ERROR(SP_ERR_MEM, "sp_event_set malloc() failed");
1165
1166         memset(result, 0, sizeof(struct sp_event_set));
1167
1168         *result_ptr = result;
1169
1170         RETURN_OK();
1171 }
1172
1173 static enum sp_return add_handle(struct sp_event_set *event_set,
1174                 event_handle handle, enum sp_event mask)
1175 {
1176         void *new_handles;
1177         enum sp_event *new_masks;
1178
1179         TRACE("%p, %d, %d", event_set, handle, mask);
1180
1181         if (!(new_handles = realloc(event_set->handles,
1182                         sizeof(event_handle) * (event_set->count + 1))))
1183                 RETURN_ERROR(SP_ERR_MEM, "Handle array realloc() failed");
1184
1185         event_set->handles = new_handles;
1186
1187         if (!(new_masks = realloc(event_set->masks,
1188                         sizeof(enum sp_event) * (event_set->count + 1))))
1189                 RETURN_ERROR(SP_ERR_MEM, "Mask array realloc() failed");
1190
1191         event_set->masks = new_masks;
1192
1193         ((event_handle *) event_set->handles)[event_set->count] = handle;
1194         event_set->masks[event_set->count] = mask;
1195
1196         event_set->count++;
1197
1198         RETURN_OK();
1199 }
1200
1201 SP_API enum sp_return sp_add_port_events(struct sp_event_set *event_set,
1202         const struct sp_port *port, enum sp_event mask)
1203 {
1204         TRACE("%p, %p, %d", event_set, port, mask);
1205
1206         if (!event_set)
1207                 RETURN_ERROR(SP_ERR_ARG, "Null event set");
1208
1209         if (!port)
1210                 RETURN_ERROR(SP_ERR_ARG, "Null port");
1211
1212         if (mask > (SP_EVENT_RX_READY | SP_EVENT_TX_READY | SP_EVENT_ERROR))
1213                 RETURN_ERROR(SP_ERR_ARG, "Invalid event mask");
1214
1215         if (!mask)
1216                 RETURN_OK();
1217
1218 #ifdef _WIN32
1219         enum sp_event handle_mask;
1220         if ((handle_mask = mask & SP_EVENT_TX_READY))
1221                 TRY(add_handle(event_set, port->write_ovl.hEvent, handle_mask));
1222         if ((handle_mask = mask & (SP_EVENT_RX_READY | SP_EVENT_ERROR)))
1223                 TRY(add_handle(event_set, port->wait_ovl.hEvent, handle_mask));
1224 #else
1225         TRY(add_handle(event_set, port->fd, mask));
1226 #endif
1227
1228         RETURN_OK();
1229 }
1230
1231 SP_API void sp_free_event_set(struct sp_event_set *event_set)
1232 {
1233         TRACE("%p", event_set);
1234
1235         if (!event_set) {
1236                 DEBUG("Null event set");
1237                 RETURN();
1238         }
1239
1240         DEBUG("Freeing event set");
1241
1242         if (event_set->handles)
1243                 free(event_set->handles);
1244         if (event_set->masks)
1245                 free(event_set->masks);
1246
1247         free(event_set);
1248
1249         RETURN();
1250 }
1251
1252 SP_API enum sp_return sp_wait(struct sp_event_set *event_set,
1253                               unsigned int timeout_ms)
1254 {
1255         TRACE("%p, %d", event_set, timeout_ms);
1256
1257         if (!event_set)
1258                 RETURN_ERROR(SP_ERR_ARG, "Null event set");
1259
1260 #ifdef _WIN32
1261         if (WaitForMultipleObjects(event_set->count, event_set->handles, FALSE,
1262                         timeout_ms ? timeout_ms : INFINITE) == WAIT_FAILED)
1263                 RETURN_FAIL("WaitForMultipleObjects() failed");
1264
1265         RETURN_OK();
1266 #else
1267         struct timeval start, delta, now, end = {0, 0};
1268         int result, timeout_remaining_ms;
1269         struct pollfd *pollfds;
1270         unsigned int i;
1271
1272         if (!(pollfds = malloc(sizeof(struct pollfd) * event_set->count)))
1273                 RETURN_ERROR(SP_ERR_MEM, "pollfds malloc() failed");
1274
1275         for (i = 0; i < event_set->count; i++) {
1276                 pollfds[i].fd = ((int *) event_set->handles)[i];
1277                 pollfds[i].events = 0;
1278                 pollfds[i].revents = 0;
1279                 if (event_set->masks[i] & SP_EVENT_RX_READY)
1280                         pollfds[i].events |= POLLIN;
1281                 if (event_set->masks[i] & SP_EVENT_TX_READY)
1282                         pollfds[i].events |= POLLOUT;
1283                 if (event_set->masks[i] & SP_EVENT_ERROR)
1284                         pollfds[i].events |= POLLERR;
1285         }
1286
1287         if (timeout_ms) {
1288                 /* Get time at start of operation. */
1289                 gettimeofday(&start, NULL);
1290                 /* Define duration of timeout. */
1291                 delta.tv_sec = timeout_ms / 1000;
1292                 delta.tv_usec = (timeout_ms % 1000) * 1000;
1293                 /* Calculate time at which we should give up. */
1294                 timeradd(&start, &delta, &end);
1295         }
1296
1297         /* Loop until an event occurs. */
1298         while (1) {
1299                 if (timeout_ms) {
1300                         gettimeofday(&now, NULL);
1301                         if (timercmp(&now, &end, >)) {
1302                                 DEBUG("Wait timed out");
1303                                 break;
1304                         }
1305                         timersub(&end, &now, &delta);
1306                         timeout_remaining_ms = delta.tv_sec * 1000 + delta.tv_usec / 1000;
1307                 }
1308
1309                 result = poll(pollfds, event_set->count, timeout_ms ? timeout_remaining_ms : -1);
1310
1311                 if (result < 0) {
1312                         if (errno == EINTR) {
1313                                 DEBUG("poll() call was interrupted, repeating");
1314                                 continue;
1315                         } else {
1316                                 free(pollfds);
1317                                 RETURN_FAIL("poll() failed");
1318                         }
1319                 } else if (result == 0) {
1320                         DEBUG("poll() timed out");
1321                         break;
1322                 } else {
1323                         DEBUG("poll() completed");
1324                         break;
1325                 }
1326         }
1327
1328         free(pollfds);
1329         RETURN_OK();
1330 #endif
1331 }
1332
1333 #ifdef USE_TERMIOS_SPEED
1334 static enum sp_return get_baudrate(int fd, int *baudrate)
1335 {
1336         void *data;
1337
1338         TRACE("%d, %p", fd, baudrate);
1339
1340         DEBUG("Getting baud rate");
1341
1342         if (!(data = malloc(get_termios_size())))
1343                 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1344
1345         if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1346                 free(data);
1347                 RETURN_FAIL("Getting termios failed");
1348         }
1349
1350         *baudrate = get_termios_speed(data);
1351
1352         free(data);
1353
1354         RETURN_OK();
1355 }
1356
1357 static enum sp_return set_baudrate(int fd, int baudrate)
1358 {
1359         void *data;
1360
1361         TRACE("%d, %d", fd, baudrate);
1362
1363         DEBUG("Getting baud rate");
1364
1365         if (!(data = malloc(get_termios_size())))
1366                 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1367
1368         if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1369                 free(data);
1370                 RETURN_FAIL("Getting termios failed");
1371         }
1372
1373         DEBUG("Setting baud rate");
1374
1375         set_termios_speed(data, baudrate);
1376
1377         if (ioctl(fd, get_termios_set_ioctl(), data) < 0) {
1378                 free(data);
1379                 RETURN_FAIL("Setting termios failed");
1380         }
1381
1382         free(data);
1383
1384         RETURN_OK();
1385 }
1386 #endif /* USE_TERMIOS_SPEED */
1387
1388 #ifdef USE_TERMIOX
1389 static enum sp_return get_flow(int fd, struct port_data *data)
1390 {
1391         void *termx;
1392
1393         TRACE("%d, %p", fd, data);
1394
1395         DEBUG("Getting advanced flow control");
1396
1397         if (!(termx = malloc(get_termiox_size())))
1398                 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1399
1400         if (ioctl(fd, TCGETX, termx) < 0) {
1401                 free(termx);
1402                 RETURN_FAIL("Getting termiox failed");
1403         }
1404
1405         get_termiox_flow(termx, &data->rts_flow, &data->cts_flow,
1406                         &data->dtr_flow, &data->dsr_flow);
1407
1408         free(termx);
1409
1410         RETURN_OK();
1411 }
1412
1413 static enum sp_return set_flow(int fd, struct port_data *data)
1414 {
1415         void *termx;
1416
1417         TRACE("%d, %p", fd, data);
1418
1419         DEBUG("Getting advanced flow control");
1420
1421         if (!(termx = malloc(get_termiox_size())))
1422                 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1423
1424         if (ioctl(fd, TCGETX, termx) < 0) {
1425                 free(termx);
1426                 RETURN_FAIL("Getting termiox failed");
1427         }
1428
1429         DEBUG("Setting advanced flow control");
1430
1431         set_termiox_flow(termx, data->rts_flow, data->cts_flow,
1432                         data->dtr_flow, data->dsr_flow);
1433
1434         if (ioctl(fd, TCSETX, termx) < 0) {
1435                 free(termx);
1436                 RETURN_FAIL("Setting termiox failed");
1437         }
1438
1439         free(termx);
1440
1441         RETURN_OK();
1442 }
1443 #endif /* USE_TERMIOX */
1444
1445 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
1446         struct sp_port_config *config)
1447 {
1448         unsigned int i;
1449
1450         TRACE("%p, %p, %p", port, data, config);
1451
1452         DEBUG_FMT("Getting configuration for port %s", port->name);
1453
1454 #ifdef _WIN32
1455         if (!GetCommState(port->hdl, &data->dcb))
1456                 RETURN_FAIL("GetCommState() failed");
1457
1458         for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1459                 if (data->dcb.BaudRate == std_baudrates[i].index) {
1460                         config->baudrate = std_baudrates[i].value;
1461                         break;
1462                 }
1463         }
1464
1465         if (i == NUM_STD_BAUDRATES)
1466                 /* BaudRate field can be either an index or a custom baud rate. */
1467                 config->baudrate = data->dcb.BaudRate;
1468
1469         config->bits = data->dcb.ByteSize;
1470
1471         if (data->dcb.fParity)
1472                 switch (data->dcb.Parity) {
1473                 case NOPARITY:
1474                         config->parity = SP_PARITY_NONE;
1475                         break;
1476                 case ODDPARITY:
1477                         config->parity = SP_PARITY_ODD;
1478                         break;
1479                 case EVENPARITY:
1480                         config->parity = SP_PARITY_EVEN;
1481                         break;
1482                 case MARKPARITY:
1483                         config->parity = SP_PARITY_MARK;
1484                         break;
1485                 case SPACEPARITY:
1486                         config->parity = SP_PARITY_SPACE;
1487                         break;
1488                 default:
1489                         config->parity = -1;
1490                 }
1491         else
1492                 config->parity = SP_PARITY_NONE;
1493
1494         switch (data->dcb.StopBits) {
1495         case ONESTOPBIT:
1496                 config->stopbits = 1;
1497                 break;
1498         case TWOSTOPBITS:
1499                 config->stopbits = 2;
1500                 break;
1501         default:
1502                 config->stopbits = -1;
1503         }
1504
1505         switch (data->dcb.fRtsControl) {
1506         case RTS_CONTROL_DISABLE:
1507                 config->rts = SP_RTS_OFF;
1508                 break;
1509         case RTS_CONTROL_ENABLE:
1510                 config->rts = SP_RTS_ON;
1511                 break;
1512         case RTS_CONTROL_HANDSHAKE:
1513                 config->rts = SP_RTS_FLOW_CONTROL;
1514                 break;
1515         default:
1516                 config->rts = -1;
1517         }
1518
1519         config->cts = data->dcb.fOutxCtsFlow ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1520
1521         switch (data->dcb.fDtrControl) {
1522         case DTR_CONTROL_DISABLE:
1523                 config->dtr = SP_DTR_OFF;
1524                 break;
1525         case DTR_CONTROL_ENABLE:
1526                 config->dtr = SP_DTR_ON;
1527                 break;
1528         case DTR_CONTROL_HANDSHAKE:
1529                 config->dtr = SP_DTR_FLOW_CONTROL;
1530                 break;
1531         default:
1532                 config->dtr = -1;
1533         }
1534
1535         config->dsr = data->dcb.fOutxDsrFlow ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1536
1537         if (data->dcb.fInX) {
1538                 if (data->dcb.fOutX)
1539                         config->xon_xoff = SP_XONXOFF_INOUT;
1540                 else
1541                         config->xon_xoff = SP_XONXOFF_IN;
1542         } else {
1543                 if (data->dcb.fOutX)
1544                         config->xon_xoff = SP_XONXOFF_OUT;
1545                 else
1546                         config->xon_xoff = SP_XONXOFF_DISABLED;
1547         }
1548
1549 #else // !_WIN32
1550
1551         if (tcgetattr(port->fd, &data->term) < 0)
1552                 RETURN_FAIL("tcgetattr() failed");
1553
1554         if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0)
1555                 RETURN_FAIL("TIOCMGET ioctl failed");
1556
1557 #ifdef USE_TERMIOX
1558         int ret = get_flow(port->fd, data);
1559
1560         if (ret == SP_ERR_FAIL && errno == EINVAL)
1561                 data->termiox_supported = 0;
1562         else if (ret < 0)
1563                 RETURN_CODEVAL(ret);
1564         else
1565                 data->termiox_supported = 1;
1566 #else
1567         data->termiox_supported = 0;
1568 #endif
1569
1570         for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1571                 if (cfgetispeed(&data->term) == std_baudrates[i].index) {
1572                         config->baudrate = std_baudrates[i].value;
1573                         break;
1574                 }
1575         }
1576
1577         if (i == NUM_STD_BAUDRATES) {
1578 #ifdef __APPLE__
1579                 config->baudrate = (int)data->term.c_ispeed;
1580 #elif defined(USE_TERMIOS_SPEED)
1581                 TRY(get_baudrate(port->fd, &config->baudrate));
1582 #else
1583                 config->baudrate = -1;
1584 #endif
1585         }
1586
1587         switch (data->term.c_cflag & CSIZE) {
1588         case CS8:
1589                 config->bits = 8;
1590                 break;
1591         case CS7:
1592                 config->bits = 7;
1593                 break;
1594         case CS6:
1595                 config->bits = 6;
1596                 break;
1597         case CS5:
1598                 config->bits = 5;
1599                 break;
1600         default:
1601                 config->bits = -1;
1602         }
1603
1604         if (!(data->term.c_cflag & PARENB) && (data->term.c_iflag & IGNPAR))
1605                 config->parity = SP_PARITY_NONE;
1606         else if (!(data->term.c_cflag & PARENB) || (data->term.c_iflag & IGNPAR))
1607                 config->parity = -1;
1608 #ifdef CMSPAR
1609         else if (data->term.c_cflag & CMSPAR)
1610                 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_MARK : SP_PARITY_SPACE;
1611 #endif
1612         else
1613                 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_ODD : SP_PARITY_EVEN;
1614
1615         config->stopbits = (data->term.c_cflag & CSTOPB) ? 2 : 1;
1616
1617         if (data->term.c_cflag & CRTSCTS) {
1618                 config->rts = SP_RTS_FLOW_CONTROL;
1619                 config->cts = SP_CTS_FLOW_CONTROL;
1620         } else {
1621                 if (data->termiox_supported && data->rts_flow)
1622                         config->rts = SP_RTS_FLOW_CONTROL;
1623                 else
1624                         config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
1625
1626                 config->cts = (data->termiox_supported && data->cts_flow) ?
1627                         SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1628         }
1629
1630         if (data->termiox_supported && data->dtr_flow)
1631                 config->dtr = SP_DTR_FLOW_CONTROL;
1632         else
1633                 config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
1634
1635         config->dsr = (data->termiox_supported && data->dsr_flow) ?
1636                 SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1637
1638         if (data->term.c_iflag & IXOFF) {
1639                 if (data->term.c_iflag & IXON)
1640                         config->xon_xoff = SP_XONXOFF_INOUT;
1641                 else
1642                         config->xon_xoff = SP_XONXOFF_IN;
1643         } else {
1644                 if (data->term.c_iflag & IXON)
1645                         config->xon_xoff = SP_XONXOFF_OUT;
1646                 else
1647                         config->xon_xoff = SP_XONXOFF_DISABLED;
1648         }
1649 #endif
1650
1651         RETURN_OK();
1652 }
1653
1654 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
1655         const struct sp_port_config *config)
1656 {
1657         unsigned int i;
1658 #ifdef __APPLE__
1659         BAUD_TYPE baud_nonstd;
1660
1661         baud_nonstd = B0;
1662 #endif
1663 #ifdef USE_TERMIOS_SPEED
1664         int baud_nonstd = 0;
1665 #endif
1666
1667         TRACE("%p, %p, %p", port, data, config);
1668
1669         DEBUG_FMT("Setting configuration for port %s", port->name);
1670
1671 #ifdef _WIN32
1672         if (config->baudrate >= 0) {
1673                 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1674                         if (config->baudrate == std_baudrates[i].value) {
1675                                 data->dcb.BaudRate = std_baudrates[i].index;
1676                                 break;
1677                         }
1678                 }
1679
1680                 if (i == NUM_STD_BAUDRATES)
1681                         data->dcb.BaudRate = config->baudrate;
1682         }
1683
1684         if (config->bits >= 0)
1685                 data->dcb.ByteSize = config->bits;
1686
1687         if (config->parity >= 0) {
1688                 switch (config->parity) {
1689                 case SP_PARITY_NONE:
1690                         data->dcb.Parity = NOPARITY;
1691                         break;
1692                 case SP_PARITY_ODD:
1693                         data->dcb.Parity = ODDPARITY;
1694                         break;
1695                 case SP_PARITY_EVEN:
1696                         data->dcb.Parity = EVENPARITY;
1697                         break;
1698                 case SP_PARITY_MARK:
1699                         data->dcb.Parity = MARKPARITY;
1700                         break;
1701                 case SP_PARITY_SPACE:
1702                         data->dcb.Parity = SPACEPARITY;
1703                         break;
1704                 default:
1705                         RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1706                 }
1707         }
1708
1709         if (config->stopbits >= 0) {
1710                 switch (config->stopbits) {
1711                 /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
1712                 case 1:
1713                         data->dcb.StopBits = ONESTOPBIT;
1714                         break;
1715                 case 2:
1716                         data->dcb.StopBits = TWOSTOPBITS;
1717                         break;
1718                 default:
1719                         RETURN_ERROR(SP_ERR_ARG, "Invalid stop bit setting");
1720                 }
1721         }
1722
1723         if (config->rts >= 0) {
1724                 switch (config->rts) {
1725                 case SP_RTS_OFF:
1726                         data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
1727                         break;
1728                 case SP_RTS_ON:
1729                         data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
1730                         break;
1731                 case SP_RTS_FLOW_CONTROL:
1732                         data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
1733                         break;
1734                 default:
1735                         RETURN_ERROR(SP_ERR_ARG, "Invalid RTS setting");
1736                 }
1737         }
1738
1739         if (config->cts >= 0) {
1740                 switch (config->cts) {
1741                 case SP_CTS_IGNORE:
1742                         data->dcb.fOutxCtsFlow = FALSE;
1743                         break;
1744                 case SP_CTS_FLOW_CONTROL:
1745                         data->dcb.fOutxCtsFlow = TRUE;
1746                         break;
1747                 default:
1748                         RETURN_ERROR(SP_ERR_ARG, "Invalid CTS setting");
1749                 }
1750         }
1751
1752         if (config->dtr >= 0) {
1753                 switch (config->dtr) {
1754                 case SP_DTR_OFF:
1755                         data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
1756                         break;
1757                 case SP_DTR_ON:
1758                         data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
1759                         break;
1760                 case SP_DTR_FLOW_CONTROL:
1761                         data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
1762                         break;
1763                 default:
1764                         RETURN_ERROR(SP_ERR_ARG, "Invalid DTR setting");
1765                 }
1766         }
1767
1768         if (config->dsr >= 0) {
1769                 switch (config->dsr) {
1770                 case SP_DSR_IGNORE:
1771                         data->dcb.fOutxDsrFlow = FALSE;
1772                         break;
1773                 case SP_DSR_FLOW_CONTROL:
1774                         data->dcb.fOutxDsrFlow = TRUE;
1775                         break;
1776                 default:
1777                         RETURN_ERROR(SP_ERR_ARG, "Invalid DSR setting");
1778                 }
1779         }
1780
1781         if (config->xon_xoff >= 0) {
1782                 switch (config->xon_xoff) {
1783                 case SP_XONXOFF_DISABLED:
1784                         data->dcb.fInX = FALSE;
1785                         data->dcb.fOutX = FALSE;
1786                         break;
1787                 case SP_XONXOFF_IN:
1788                         data->dcb.fInX = TRUE;
1789                         data->dcb.fOutX = FALSE;
1790                         break;
1791                 case SP_XONXOFF_OUT:
1792                         data->dcb.fInX = FALSE;
1793                         data->dcb.fOutX = TRUE;
1794                         break;
1795                 case SP_XONXOFF_INOUT:
1796                         data->dcb.fInX = TRUE;
1797                         data->dcb.fOutX = TRUE;
1798                         break;
1799                 default:
1800                         RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
1801                 }
1802         }
1803
1804         if (!SetCommState(port->hdl, &data->dcb))
1805                 RETURN_FAIL("SetCommState() failed");
1806
1807 #else /* !_WIN32 */
1808
1809         int controlbits;
1810
1811         if (config->baudrate >= 0) {
1812                 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1813                         if (config->baudrate == std_baudrates[i].value) {
1814                                 if (cfsetospeed(&data->term, std_baudrates[i].index) < 0)
1815                                         RETURN_FAIL("cfsetospeed() failed");
1816
1817                                 if (cfsetispeed(&data->term, std_baudrates[i].index) < 0)
1818                                         RETURN_FAIL("cfsetispeed() failed");
1819                                 break;
1820                         }
1821                 }
1822
1823                 /* Non-standard baud rate */
1824                 if (i == NUM_STD_BAUDRATES) {
1825 #ifdef __APPLE__
1826                         /* Set "dummy" baud rate. */
1827                         if (cfsetspeed(&data->term, B9600) < 0)
1828                                 RETURN_FAIL("cfsetspeed() failed");
1829                         baud_nonstd = config->baudrate;
1830 #elif defined(USE_TERMIOS_SPEED)
1831                         baud_nonstd = 1;
1832 #else
1833                         RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported");
1834 #endif
1835                 }
1836         }
1837
1838         if (config->bits >= 0) {
1839                 data->term.c_cflag &= ~CSIZE;
1840                 switch (config->bits) {
1841                 case 8:
1842                         data->term.c_cflag |= CS8;
1843                         break;
1844                 case 7:
1845                         data->term.c_cflag |= CS7;
1846                         break;
1847                 case 6:
1848                         data->term.c_cflag |= CS6;
1849                         break;
1850                 case 5:
1851                         data->term.c_cflag |= CS5;
1852                         break;
1853                 default:
1854                         RETURN_ERROR(SP_ERR_ARG, "Invalid data bits setting");
1855                 }
1856         }
1857
1858         if (config->parity >= 0) {
1859                 data->term.c_iflag &= ~IGNPAR;
1860                 data->term.c_cflag &= ~(PARENB | PARODD);
1861 #ifdef CMSPAR
1862                 data->term.c_cflag &= ~CMSPAR;
1863 #endif
1864                 switch (config->parity) {
1865                 case SP_PARITY_NONE:
1866                         data->term.c_iflag |= IGNPAR;
1867                         break;
1868                 case SP_PARITY_EVEN:
1869                         data->term.c_cflag |= PARENB;
1870                         break;
1871                 case SP_PARITY_ODD:
1872                         data->term.c_cflag |= PARENB | PARODD;
1873                         break;
1874 #ifdef CMSPAR
1875                 case SP_PARITY_MARK:
1876                         data->term.c_cflag |= PARENB | PARODD;
1877                         data->term.c_cflag |= CMSPAR;
1878                         break;
1879                 case SP_PARITY_SPACE:
1880                         data->term.c_cflag |= PARENB;
1881                         data->term.c_cflag |= CMSPAR;
1882                         break;
1883 #else
1884                 case SP_PARITY_MARK:
1885                 case SP_PARITY_SPACE:
1886                         RETURN_ERROR(SP_ERR_SUPP, "Mark/space parity not supported");
1887 #endif
1888                 default:
1889                         RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1890                 }
1891         }
1892
1893         if (config->stopbits >= 0) {
1894                 data->term.c_cflag &= ~CSTOPB;
1895                 switch (config->stopbits) {
1896                 case 1:
1897                         data->term.c_cflag &= ~CSTOPB;
1898                         break;
1899                 case 2:
1900                         data->term.c_cflag |= CSTOPB;
1901                         break;
1902                 default:
1903                         RETURN_ERROR(SP_ERR_ARG, "Invalid stop bits setting");
1904                 }
1905         }
1906
1907         if (config->rts >= 0 || config->cts >= 0) {
1908                 if (data->termiox_supported) {
1909                         data->rts_flow = data->cts_flow = 0;
1910                         switch (config->rts) {
1911                         case SP_RTS_OFF:
1912                         case SP_RTS_ON:
1913                                 controlbits = TIOCM_RTS;
1914                                 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
1915                                         RETURN_FAIL("Setting RTS signal level failed");
1916                                 break;
1917                         case SP_RTS_FLOW_CONTROL:
1918                                 data->rts_flow = 1;
1919                                 break;
1920                         default:
1921                                 break;
1922                         }
1923                         if (config->cts == SP_CTS_FLOW_CONTROL)
1924                                 data->cts_flow = 1;
1925
1926                         if (data->rts_flow && data->cts_flow)
1927                                 data->term.c_iflag |= CRTSCTS;
1928                         else
1929                                 data->term.c_iflag &= ~CRTSCTS;
1930                 } else {
1931                         /* Asymmetric use of RTS/CTS not supported. */
1932                         if (data->term.c_iflag & CRTSCTS) {
1933                                 /* Flow control can only be disabled for both RTS & CTS together. */
1934                                 if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) {
1935                                         if (config->cts != SP_CTS_IGNORE)
1936                                                 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
1937                                 }
1938                                 if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) {
1939                                         if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL)
1940                                                 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
1941                                 }
1942                         } else {
1943                                 /* Flow control can only be enabled for both RTS & CTS together. */
1944                                 if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) ||
1945                                         ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL)))
1946                                         RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be enabled together");
1947                         }
1948
1949                         if (config->rts >= 0) {
1950                                 if (config->rts == SP_RTS_FLOW_CONTROL) {
1951                                         data->term.c_iflag |= CRTSCTS;
1952                                 } else {
1953                                         controlbits = TIOCM_RTS;
1954                                         if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
1955                                                         &controlbits) < 0)
1956                                                 RETURN_FAIL("Setting RTS signal level failed");
1957                                 }
1958                         }
1959                 }
1960         }
1961
1962         if (config->dtr >= 0 || config->dsr >= 0) {
1963                 if (data->termiox_supported) {
1964                         data->dtr_flow = data->dsr_flow = 0;
1965                         switch (config->dtr) {
1966                         case SP_DTR_OFF:
1967                         case SP_DTR_ON:
1968                                 controlbits = TIOCM_DTR;
1969                                 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
1970                                         RETURN_FAIL("Setting DTR signal level failed");
1971                                 break;
1972                         case SP_DTR_FLOW_CONTROL:
1973                                 data->dtr_flow = 1;
1974                                 break;
1975                         default:
1976                                 break;
1977                         }
1978                         if (config->dsr == SP_DSR_FLOW_CONTROL)
1979                                 data->dsr_flow = 1;
1980                 } else {
1981                         /* DTR/DSR flow control not supported. */
1982                         if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
1983                                 RETURN_ERROR(SP_ERR_SUPP, "DTR/DSR flow control not supported");
1984
1985                         if (config->dtr >= 0) {
1986                                 controlbits = TIOCM_DTR;
1987                                 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
1988                                                 &controlbits) < 0)
1989                                         RETURN_FAIL("Setting DTR signal level failed");
1990                         }
1991                 }
1992         }
1993
1994         if (config->xon_xoff >= 0) {
1995                 data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
1996                 switch (config->xon_xoff) {
1997                 case SP_XONXOFF_DISABLED:
1998                         break;
1999                 case SP_XONXOFF_IN:
2000                         data->term.c_iflag |= IXOFF;
2001                         break;
2002                 case SP_XONXOFF_OUT:
2003                         data->term.c_iflag |= IXON | IXANY;
2004                         break;
2005                 case SP_XONXOFF_INOUT:
2006                         data->term.c_iflag |= IXON | IXOFF | IXANY;
2007                         break;
2008                 default:
2009                         RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
2010                 }
2011         }
2012
2013         if (tcsetattr(port->fd, TCSANOW, &data->term) < 0)
2014                 RETURN_FAIL("tcsetattr() failed");
2015
2016 #ifdef __APPLE__
2017         if (baud_nonstd != B0) {
2018                 if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1)
2019                         RETURN_FAIL("IOSSIOSPEED ioctl failed");
2020                 /*
2021                  * Set baud rates in data->term to correct, but incompatible
2022                  * with tcsetattr() value, same as delivered by tcgetattr().
2023                  */
2024                 if (cfsetspeed(&data->term, baud_nonstd) < 0)
2025                         RETURN_FAIL("cfsetspeed() failed");
2026         }
2027 #elif defined(__linux__)
2028 #ifdef USE_TERMIOS_SPEED
2029         if (baud_nonstd)
2030                 TRY(set_baudrate(port->fd, config->baudrate));
2031 #endif
2032 #ifdef USE_TERMIOX
2033         if (data->termiox_supported)
2034                 TRY(set_flow(port->fd, data));
2035 #endif
2036 #endif
2037
2038 #endif /* !_WIN32 */
2039
2040         RETURN_OK();
2041 }
2042
2043 SP_API enum sp_return sp_new_config(struct sp_port_config **config_ptr)
2044 {
2045         struct sp_port_config *config;
2046
2047         TRACE("%p", config_ptr);
2048
2049         if (!config_ptr)
2050                 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2051
2052         *config_ptr = NULL;
2053
2054         if (!(config = malloc(sizeof(struct sp_port_config))))
2055                 RETURN_ERROR(SP_ERR_MEM, "Config malloc failed");
2056
2057         config->baudrate = -1;
2058         config->bits = -1;
2059         config->parity = -1;
2060         config->stopbits = -1;
2061         config->rts = -1;
2062         config->cts = -1;
2063         config->dtr = -1;
2064         config->dsr = -1;
2065
2066         *config_ptr = config;
2067
2068         RETURN_OK();
2069 }
2070
2071 SP_API void sp_free_config(struct sp_port_config *config)
2072 {
2073         TRACE("%p", config);
2074
2075         if (!config)
2076                 DEBUG("Null config");
2077         else
2078                 free(config);
2079
2080         RETURN();
2081 }
2082
2083 SP_API enum sp_return sp_get_config(struct sp_port *port,
2084                                     struct sp_port_config *config)
2085 {
2086         struct port_data data;
2087
2088         TRACE("%p, %p", port, config);
2089
2090         CHECK_OPEN_PORT();
2091
2092         if (!config)
2093                 RETURN_ERROR(SP_ERR_ARG, "Null config");
2094
2095         TRY(get_config(port, &data, config));
2096
2097         RETURN_OK();
2098 }
2099
2100 SP_API enum sp_return sp_set_config(struct sp_port *port,
2101                                     const struct sp_port_config *config)
2102 {
2103         struct port_data data;
2104         struct sp_port_config prev_config;
2105
2106         TRACE("%p, %p", port, config);
2107
2108         CHECK_OPEN_PORT();
2109
2110         if (!config)
2111                 RETURN_ERROR(SP_ERR_ARG, "Null config");
2112
2113         TRY(get_config(port, &data, &prev_config));
2114         TRY(set_config(port, &data, config));
2115
2116         RETURN_OK();
2117 }
2118
2119 #define CREATE_ACCESSORS(x, type) \
2120 SP_API enum sp_return sp_set_##x(struct sp_port *port, type x) { \
2121         struct port_data data; \
2122         struct sp_port_config config; \
2123         TRACE("%p, %d", port, x); \
2124         CHECK_OPEN_PORT(); \
2125         TRY(get_config(port, &data, &config)); \
2126         config.x = x; \
2127         TRY(set_config(port, &data, &config)); \
2128         RETURN_OK(); \
2129 } \
2130 SP_API enum sp_return sp_get_config_##x(const struct sp_port_config *config, \
2131                                         type *x) { \
2132         TRACE("%p, %p", config, x); \
2133         if (!x) \
2134                 RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); \
2135         if (!config) \
2136                 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2137         *x = config->x; \
2138         RETURN_OK(); \
2139 } \
2140 SP_API enum sp_return sp_set_config_##x(struct sp_port_config *config, \
2141                                         type x) { \
2142         TRACE("%p, %d", config, x); \
2143         if (!config) \
2144                 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2145         config->x = x; \
2146         RETURN_OK(); \
2147 }
2148
2149 CREATE_ACCESSORS(baudrate, int)
2150 CREATE_ACCESSORS(bits, int)
2151 CREATE_ACCESSORS(parity, enum sp_parity)
2152 CREATE_ACCESSORS(stopbits, int)
2153 CREATE_ACCESSORS(rts, enum sp_rts)
2154 CREATE_ACCESSORS(cts, enum sp_cts)
2155 CREATE_ACCESSORS(dtr, enum sp_dtr)
2156 CREATE_ACCESSORS(dsr, enum sp_dsr)
2157 CREATE_ACCESSORS(xon_xoff, enum sp_xonxoff)
2158
2159 SP_API enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config,
2160                                                 enum sp_flowcontrol flowcontrol)
2161 {
2162         if (!config)
2163                 RETURN_ERROR(SP_ERR_ARG, "Null configuration");
2164
2165         if (flowcontrol > SP_FLOWCONTROL_DTRDSR)
2166                 RETURN_ERROR(SP_ERR_ARG, "Invalid flow control setting");
2167
2168         if (flowcontrol == SP_FLOWCONTROL_XONXOFF)
2169                 config->xon_xoff = SP_XONXOFF_INOUT;
2170         else
2171                 config->xon_xoff = SP_XONXOFF_DISABLED;
2172
2173         if (flowcontrol == SP_FLOWCONTROL_RTSCTS) {
2174                 config->rts = SP_RTS_FLOW_CONTROL;
2175                 config->cts = SP_CTS_FLOW_CONTROL;
2176         } else {
2177                 if (config->rts == SP_RTS_FLOW_CONTROL)
2178                         config->rts = SP_RTS_ON;
2179                 config->cts = SP_CTS_IGNORE;
2180         }
2181
2182         if (flowcontrol == SP_FLOWCONTROL_DTRDSR) {
2183                 config->dtr = SP_DTR_FLOW_CONTROL;
2184                 config->dsr = SP_DSR_FLOW_CONTROL;
2185         } else {
2186                 if (config->dtr == SP_DTR_FLOW_CONTROL)
2187                         config->dtr = SP_DTR_ON;
2188                 config->dsr = SP_DSR_IGNORE;
2189         }
2190
2191         RETURN_OK();
2192 }
2193
2194 SP_API enum sp_return sp_set_flowcontrol(struct sp_port *port,
2195                                          enum sp_flowcontrol flowcontrol)
2196 {
2197         struct port_data data;
2198         struct sp_port_config config;
2199
2200         TRACE("%p, %d", port, flowcontrol);
2201
2202         CHECK_OPEN_PORT();
2203
2204         TRY(get_config(port, &data, &config));
2205
2206         TRY(sp_set_config_flowcontrol(&config, flowcontrol));
2207
2208         TRY(set_config(port, &data, &config));
2209
2210         RETURN_OK();
2211 }
2212
2213 SP_API enum sp_return sp_get_signals(struct sp_port *port,
2214                                      enum sp_signal *signals)
2215 {
2216         TRACE("%p, %p", port, signals);
2217
2218         CHECK_OPEN_PORT();
2219
2220         if (!signals)
2221                 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2222
2223         DEBUG_FMT("Getting control signals for port %s", port->name);
2224
2225         *signals = 0;
2226 #ifdef _WIN32
2227         DWORD bits;
2228         if (GetCommModemStatus(port->hdl, &bits) == 0)
2229                 RETURN_FAIL("GetCommModemStatus() failed");
2230         if (bits & MS_CTS_ON)
2231                 *signals |= SP_SIG_CTS;
2232         if (bits & MS_DSR_ON)
2233                 *signals |= SP_SIG_DSR;
2234         if (bits & MS_RLSD_ON)
2235                 *signals |= SP_SIG_DCD;
2236         if (bits & MS_RING_ON)
2237                 *signals |= SP_SIG_RI;
2238 #else
2239         int bits;
2240         if (ioctl(port->fd, TIOCMGET, &bits) < 0)
2241                 RETURN_FAIL("TIOCMGET ioctl failed");
2242         if (bits & TIOCM_CTS)
2243                 *signals |= SP_SIG_CTS;
2244         if (bits & TIOCM_DSR)
2245                 *signals |= SP_SIG_DSR;
2246         if (bits & TIOCM_CAR)
2247                 *signals |= SP_SIG_DCD;
2248         if (bits & TIOCM_RNG)
2249                 *signals |= SP_SIG_RI;
2250 #endif
2251         RETURN_OK();
2252 }
2253
2254 SP_API enum sp_return sp_start_break(struct sp_port *port)
2255 {
2256         TRACE("%p", port);
2257
2258         CHECK_OPEN_PORT();
2259 #ifdef _WIN32
2260         if (SetCommBreak(port->hdl) == 0)
2261                 RETURN_FAIL("SetCommBreak() failed");
2262 #else
2263         if (ioctl(port->fd, TIOCSBRK, 1) < 0)
2264                 RETURN_FAIL("TIOCSBRK ioctl failed");
2265 #endif
2266
2267         RETURN_OK();
2268 }
2269
2270 SP_API enum sp_return sp_end_break(struct sp_port *port)
2271 {
2272         TRACE("%p", port);
2273
2274         CHECK_OPEN_PORT();
2275 #ifdef _WIN32
2276         if (ClearCommBreak(port->hdl) == 0)
2277                 RETURN_FAIL("ClearCommBreak() failed");
2278 #else
2279         if (ioctl(port->fd, TIOCCBRK, 1) < 0)
2280                 RETURN_FAIL("TIOCCBRK ioctl failed");
2281 #endif
2282
2283         RETURN_OK();
2284 }
2285
2286 SP_API int sp_last_error_code(void)
2287 {
2288         TRACE_VOID();
2289 #ifdef _WIN32
2290         RETURN_INT(GetLastError());
2291 #else
2292         RETURN_INT(errno);
2293 #endif
2294 }
2295
2296 SP_API char *sp_last_error_message(void)
2297 {
2298         TRACE_VOID();
2299
2300 #ifdef _WIN32
2301         TCHAR *message;
2302         DWORD error = GetLastError();
2303
2304         DWORD length = FormatMessage(
2305                 FORMAT_MESSAGE_ALLOCATE_BUFFER |
2306                 FORMAT_MESSAGE_FROM_SYSTEM |
2307                 FORMAT_MESSAGE_IGNORE_INSERTS,
2308                 NULL,
2309                 error,
2310                 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
2311                 (LPTSTR) &message,
2312                 0, NULL );
2313
2314         if (length >= 2 && message[length - 2] == '\r')
2315                 message[length - 2] = '\0';
2316
2317         RETURN_STRING(message);
2318 #else
2319         RETURN_STRING(strerror(errno));
2320 #endif
2321 }
2322
2323 SP_API void sp_free_error_message(char *message)
2324 {
2325         TRACE("%s", message);
2326
2327 #ifdef _WIN32
2328         LocalFree(message);
2329 #else
2330         (void)message;
2331 #endif
2332
2333         RETURN();
2334 }
2335
2336 SP_API void sp_set_debug_handler(void (*handler)(const char *format, ...))
2337 {
2338         TRACE("%p", handler);
2339
2340         sp_debug_handler = handler;
2341
2342         RETURN();
2343 }
2344
2345 SP_API void sp_default_debug_handler(const char *format, ...)
2346 {
2347         va_list args;
2348         va_start(args, format);
2349         if (getenv("LIBSERIALPORT_DEBUG")) {
2350                 fputs("sp: ", stderr);
2351                 vfprintf(stderr, format, args);
2352         }
2353         va_end(args);
2354 }
2355
2356 SP_API int sp_get_major_package_version(void)
2357 {
2358         return SP_PACKAGE_VERSION_MAJOR;
2359 }
2360
2361 SP_API int sp_get_minor_package_version(void)
2362 {
2363         return SP_PACKAGE_VERSION_MINOR;
2364 }
2365
2366 SP_API int sp_get_micro_package_version(void)
2367 {
2368         return SP_PACKAGE_VERSION_MICRO;
2369 }
2370
2371 SP_API const char *sp_get_package_version_string(void)
2372 {
2373         return SP_PACKAGE_VERSION_STRING;
2374 }
2375
2376 SP_API int sp_get_current_lib_version(void)
2377 {
2378         return SP_LIB_VERSION_CURRENT;
2379 }
2380
2381 SP_API int sp_get_revision_lib_version(void)
2382 {
2383         return SP_LIB_VERSION_REVISION;
2384 }
2385
2386 SP_API int sp_get_age_lib_version(void)
2387 {
2388         return SP_LIB_VERSION_AGE;
2389 }
2390
2391 SP_API const char *sp_get_lib_version_string(void)
2392 {
2393         return SP_LIB_VERSION_STRING;
2394 }
2395
2396 /** @} */