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