serialport.c

   1 /*
   2  * This file is part of the libserialport project.
   3  *
   4  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
   5  * Copyright (C) 2010-2012 Uwe Hermann <uwe@hermann-uwe.de>
   6  * Copyright (C) 2013 Martin Ling <martin-libserialport@earth.li>
   7  * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
   8  *
   9  * This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Lesser General Public License as
  11  * published by the Free Software Foundation, either version 3 of the
  12  * License, or (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23 #include <string.h>
  24 #include <sys/types.h>
  25 #include <sys/stat.h>
  26 #include <fcntl.h>
  27 #include <unistd.h>
  28 #include <stdlib.h>
  29 #include <errno.h>
  30 #ifdef _WIN32
  31 #include <windows.h>
  32 #include <tchar.h>
  33 #include <stdio.h>
  34 #else
  35 #include <termios.h>
  36 #include <sys/ioctl.h>
  37 #endif
  38 #ifdef __APPLE__
  39 #include <IOKit/IOKitLib.h>
  40 #include <IOKit/serial/IOSerialKeys.h>
  41 #include <IOKit/serial/ioss.h>
  42 #include <sys/syslimits.h>
  43 #endif
  44 #ifdef __linux__
  45 #include "libudev.h"
  46 #include "linux/serial.h"
  47 #include "linux_termios.h"
  48 #if defined(TCGETX) && defined(TCSETX) && defined(HAVE_TERMIOX)
  49 #define USE_TERMIOX
  50 #endif
  51 #endif
  52
  53 #include "libserialport.h"
  54
  55 struct port_data {
  56 #ifdef _WIN32
  57         DCB dcb;
  58 #else
  59         struct termios term;
  60         int controlbits;
  61 #ifdef USE_TERMIOX
  62         int flow;
  63 #endif
  64 #endif
  65 };
  66
  67 /* Standard baud rates. */
  68 #ifdef _WIN32
  69 #define BAUD_TYPE DWORD
  70 #define BAUD(n) {CBR_##n, n}
  71 #else
  72 #define BAUD_TYPE speed_t
  73 #define BAUD(n) {B##n, n}
  74 #endif
  75
  76 struct std_baudrate {
  77         BAUD_TYPE index;
  78         int value;
  79 };
  80
  81 const struct std_baudrate std_baudrates[] = {
  82 #ifdef _WIN32
  83         /*
  84          * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
  85          * have documented CBR_* macros.
  86          */
  87         BAUD(110), BAUD(300), BAUD(600), BAUD(1200), BAUD(2400), BAUD(4800),
  88         BAUD(9600), BAUD(14400), BAUD(19200), BAUD(38400), BAUD(57600),
  89         BAUD(115200), BAUD(128000), BAUD(256000),
  90 #else
  91         BAUD(50), BAUD(75), BAUD(110), BAUD(134), BAUD(150), BAUD(200),
  92         BAUD(300), BAUD(600), BAUD(1200), BAUD(1800), BAUD(2400), BAUD(4800),
  93         BAUD(9600), BAUD(19200), BAUD(38400), BAUD(57600), BAUD(115200),
  94         BAUD(230400),
  95 #if !defined(__APPLE__) && !defined(__OpenBSD__)
  96         BAUD(460800),
  97 #endif
  98 #endif
  99 };
 100
 101 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
 102 #define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates)
 103
 104 #define TRY(x) do { int ret = x; if (ret != SP_OK) return ret; } while (0)
 105
 106 /* Helper functions. */
 107 static enum sp_return validate_port(struct sp_port *port);
 108 static struct sp_port **list_append(struct sp_port **list, const char *portname);
 109 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
 110         struct sp_port_config *config);
 111 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
 112         const struct sp_port_config *config);
 113
 114 enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
 115 {
 116         struct sp_port *port;
 117         int len;
 118
 119         if (!port_ptr)
 120                 return SP_ERR_ARG;
 121
 122         *port_ptr = NULL;
 123
 124         if (!portname)
 125                 return SP_ERR_ARG;
 126
 127         if (!(port = malloc(sizeof(struct sp_port))))
 128                 return SP_ERR_MEM;
 129
 130         len = strlen(portname) + 1;
 131
 132         if (!(port->name = malloc(len))) {
 133                 free(port);
 134                 return SP_ERR_MEM;
 135         }
 136
 137         memcpy(port->name, portname, len);
 138
 139 #ifdef _WIN32
 140         port->hdl = INVALID_HANDLE_VALUE;
 141 #else
 142         port->fd = -1;
 143 #endif
 144
 145         *port_ptr = port;
 146
 147         return SP_OK;
 148 }
 149
 150 enum sp_return sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr)
 151 {
 152         if (!copy_ptr)
 153                 return SP_ERR_ARG;
 154
 155         *copy_ptr = NULL;
 156
 157         if (!port || !port->name)
 158                 return SP_ERR_ARG;
 159
 160         return sp_get_port_by_name(port->name, copy_ptr);
 161 }
 162
 163 void sp_free_port(struct sp_port *port)
 164 {
 165         if (!port)
 166                 return;
 167
 168         if (port->name)
 169                 free(port->name);
 170
 171         free(port);
 172 }
 173
 174 static struct sp_port **list_append(struct sp_port **list, const char *portname)
 175 {
 176         void *tmp;
 177         unsigned int count;
 178
 179         for (count = 0; list[count]; count++);
 180         if (!(tmp = realloc(list, sizeof(struct sp_port *) * (count + 2))))
 181                 goto fail;
 182         list = tmp;
 183         if (sp_get_port_by_name(portname, &list[count]) != SP_OK)
 184                 goto fail;
 185         list[count + 1] = NULL;
 186         return list;
 187
 188 fail:
 189         sp_free_port_list(list);
 190         return NULL;
 191 }
 192
 193 enum sp_return sp_list_ports(struct sp_port ***list_ptr)
 194 {
 195         struct sp_port **list;
 196         int ret = SP_OK;
 197
 198         if (!(list = malloc(sizeof(struct sp_port **))))
 199                 return SP_ERR_MEM;
 200
 201         list[0] = NULL;
 202
 203 #ifdef _WIN32
 204         HKEY key;
 205         TCHAR *value, *data;
 206         DWORD max_value_len, max_data_size, max_data_len;
 207         DWORD value_len, data_size, data_len;
 208         DWORD type, index = 0;
 209         char *name;
 210         int name_len;
 211
 212         if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T("HARDWARE\\DEVICEMAP\\SERIALCOMM"),
 213                         0, KEY_QUERY_VALUE, &key) != ERROR_SUCCESS) {
 214                 ret = SP_ERR_FAIL;
 215                 goto out_done;
 216         }
 217         if (RegQueryInfoKey(key, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
 218                                 &max_value_len, &max_data_size, NULL, NULL) != ERROR_SUCCESS) {
 219                 ret = SP_ERR_FAIL;
 220                 goto out_close;
 221         }
 222         max_data_len = max_data_size / sizeof(TCHAR);
 223         if (!(value = malloc((max_value_len + 1) * sizeof(TCHAR)))) {
 224                 ret = SP_ERR_MEM;
 225                 goto out_close;
 226         }
 227         if (!(data = malloc((max_data_len + 1) * sizeof(TCHAR)))) {
 228                 ret = SP_ERR_MEM;
 229                 goto out_free_value;
 230         }
 231         while (
 232                 value_len = max_value_len + 1,
 233                 data_size = max_data_size,
 234                 RegEnumValue(key, index, value, &value_len,
 235                         NULL, &type, (LPBYTE)data, &data_size) == ERROR_SUCCESS)
 236         {
 237                 data_len = data_size / sizeof(TCHAR);
 238                 data[data_len] = '\0';
 239 #ifdef UNICODE
 240                 name_len = WideCharToMultiByte(CP_ACP, 0, data, -1, NULL, 0, NULL, NULL)
 241 #else
 242                 name_len = data_len + 1;
 243 #endif
 244                 if (!(name = malloc(name_len))) {
 245                         ret = SP_ERR_MEM;
 246                         goto out;
 247                 }
 248 #ifdef UNICODE
 249                 WideCharToMultiByte(CP_ACP, 0, data, -1, name, name_len, NULL, NULL);
 250 #else
 251                 strcpy(name, data);
 252 #endif
 253                 if (type == REG_SZ && !(list = list_append(list, name))) {
 254                         ret = SP_ERR_MEM;
 255                         goto out;
 256                 }
 257                 index++;
 258         }
 259 out:
 260         free(data);
 261 out_free_value:
 262         free(value);
 263 out_close:
 264         RegCloseKey(key);
 265 out_done:
 266 #endif
 267 #ifdef __APPLE__
 268         mach_port_t master;
 269         CFMutableDictionaryRef classes;
 270         io_iterator_t iter;
 271         char *path;
 272         io_object_t port;
 273         CFTypeRef cf_path;
 274         Boolean result;
 275
 276         if (IOMasterPort(MACH_PORT_NULL, &master) != KERN_SUCCESS) {
 277                 ret = SP_ERR_FAIL;
 278                 goto out_done;
 279         }
 280
 281         if (!(classes = IOServiceMatching(kIOSerialBSDServiceValue))) {
 282                 ret = SP_ERR_FAIL;
 283                 goto out_done;
 284         }
 285
 286         CFDictionarySetValue(classes,
 287                         CFSTR(kIOSerialBSDTypeKey), CFSTR(kIOSerialBSDAllTypes));
 288
 289         if (IOServiceGetMatchingServices(master, classes, &iter) != KERN_SUCCESS) {
 290                 ret = SP_ERR_FAIL;
 291                 goto out_done;
 292         }
 293
 294         if (!(path = malloc(PATH_MAX))) {
 295                 ret = SP_ERR_MEM;
 296                 goto out_release;
 297         }
 298
 299         while ((port = IOIteratorNext(iter))) {
 300                 cf_path = IORegistryEntryCreateCFProperty(port,
 301                                 CFSTR(kIOCalloutDeviceKey), kCFAllocatorDefault, 0);
 302                 if (cf_path) {
 303                         result = CFStringGetCString(cf_path,
 304                                         path, PATH_MAX, kCFStringEncodingASCII);
 305                         CFRelease(cf_path);
 306                         if (result && !(list = list_append(list, path))) {
 307                                 ret = SP_ERR_MEM;
 308                                 IOObjectRelease(port);
 309                                 goto out;
 310                         }
 311                 }
 312                 IOObjectRelease(port);
 313         }
 314 out:
 315         free(path);
 316 out_release:
 317         IOObjectRelease(iter);
 318 out_done:
 319 #endif
 320 #ifdef __linux__
 321         struct udev *ud;
 322         struct udev_enumerate *ud_enumerate;
 323         struct udev_list_entry *ud_list;
 324         struct udev_list_entry *ud_entry;
 325         const char *path;
 326         struct udev_device *ud_dev, *ud_parent;
 327         const char *name;
 328         const char *driver;
 329         int fd, ioctl_result;
 330         struct serial_struct serial_info;
 331
 332         ud = udev_new();
 333         ud_enumerate = udev_enumerate_new(ud);
 334         udev_enumerate_add_match_subsystem(ud_enumerate, "tty");
 335         udev_enumerate_scan_devices(ud_enumerate);
 336         ud_list = udev_enumerate_get_list_entry(ud_enumerate);
 337         udev_list_entry_foreach(ud_entry, ud_list) {
 338                 path = udev_list_entry_get_name(ud_entry);
 339                 ud_dev = udev_device_new_from_syspath(ud, path);
 340                 /* If there is no parent device, this is a virtual tty. */
 341                 ud_parent = udev_device_get_parent(ud_dev);
 342                 if (ud_parent == NULL) {
 343                         udev_device_unref(ud_dev);
 344                         continue;
 345                 }
 346                 name = udev_device_get_devnode(ud_dev);
 347                 /* The serial8250 driver has a hardcoded number of ports.
 348                  * The only way to tell which actually exist on a given system
 349                  * is to try to open them and make an ioctl call. */
 350                 driver = udev_device_get_driver(ud_parent);
 351                 if (driver && !strcmp(driver, "serial8250")) {
 352                         if ((fd = open(name, O_RDWR | O_NONBLOCK | O_NOCTTY)) < 0)
 353                                 goto skip;
 354                         ioctl_result = ioctl(fd, TIOCGSERIAL, &serial_info);
 355                         close(fd);
 356                         if (ioctl_result != 0)
 357                                 goto skip;
 358                         if (serial_info.type == PORT_UNKNOWN)
 359                                 goto skip;
 360                 }
 361                 list = list_append(list, name);
 362 skip:
 363                 udev_device_unref(ud_dev);
 364                 if (!list) {
 365                         ret = SP_ERR_MEM;
 366                         goto out;
 367                 }
 368         }
 369 out:
 370         udev_enumerate_unref(ud_enumerate);
 371         udev_unref(ud);
 372 #endif
 373
 374         if (ret == SP_OK) {
 375                 *list_ptr = list;
 376         } else {
 377                 if (list)
 378                         sp_free_port_list(list);
 379                 *list_ptr = NULL;
 380         }
 381
 382         return ret;
 383 }
 384
 385 void sp_free_port_list(struct sp_port **list)
 386 {
 387         unsigned int i;
 388
 389         for (i = 0; list[i]; i++)
 390                 sp_free_port(list[i]);
 391         free(list);
 392 }
 393
 394 static enum sp_return validate_port(struct sp_port *port)
 395 {
 396         if (port == NULL)
 397                 return 0;
 398 #ifdef _WIN32
 399         if (port->hdl == INVALID_HANDLE_VALUE)
 400                 return 0;
 401 #else
 402         if (port->fd < 0)
 403                 return 0;
 404 #endif
 405         return 1;
 406 }
 407
 408 #define CHECK_PORT() do { if (!validate_port(port)) return SP_ERR_ARG; } while (0)
 409
 410 enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
 411 {
 412         if (!port)
 413                 return SP_ERR_ARG;
 414
 415 #ifdef _WIN32
 416         DWORD desired_access = 0, flags_and_attributes = 0;
 417         char *escaped_port_name;
 418
 419         /* Prefix port name with '\\.\' to work with ports above COM9. */
 420         if (!(escaped_port_name = malloc(strlen(port->name + 5))))
 421                 return SP_ERR_MEM;
 422         sprintf(escaped_port_name, "\\\\.\\%s", port->name);
 423
 424         /* Map 'flags' to the OS-specific settings. */
 425         flags_and_attributes = FILE_ATTRIBUTE_NORMAL;
 426         if (flags & SP_MODE_READ)
 427                 desired_access |= GENERIC_READ;
 428         if (flags & SP_MODE_WRITE)
 429                 desired_access |= GENERIC_WRITE;
 430         if (flags & SP_MODE_NONBLOCK)
 431                 flags_and_attributes |= FILE_FLAG_OVERLAPPED;
 432
 433         port->hdl = CreateFile(escaped_port_name, desired_access, 0, 0,
 434                          OPEN_EXISTING, flags_and_attributes, 0);
 435
 436         free(escaped_port_name);
 437
 438         if (port->hdl == INVALID_HANDLE_VALUE)
 439                 return SP_ERR_FAIL;
 440 #else
 441         int flags_local = 0;
 442         struct port_data data;
 443         struct sp_port_config config;
 444         int ret;
 445
 446         /* Map 'flags' to the OS-specific settings. */
 447         if (flags & (SP_MODE_READ | SP_MODE_WRITE))
 448                 flags_local |= O_RDWR;
 449         else if (flags & SP_MODE_READ)
 450                 flags_local |= O_RDONLY;
 451         else if (flags & SP_MODE_WRITE)
 452                 flags_local |= O_WRONLY;
 453         if (flags & SP_MODE_NONBLOCK)
 454                 flags_local |= O_NONBLOCK;
 455
 456         if ((port->fd = open(port->name, flags_local)) < 0)
 457                 return SP_ERR_FAIL;
 458
 459         ret = get_config(port, &data, &config);
 460
 461         if (ret < 0) {
 462                 sp_close(port);
 463                 return ret;
 464         }
 465
 466         /* Turn off all serial port cooking. */
 467         data.term.c_iflag &= ~(ISTRIP | INLCR | ICRNL);
 468         data.term.c_oflag &= ~(ONLCR | OCRNL | ONOCR);
 469 #if !defined(__FreeBSD__) && !defined(__OpenBSD__) && !defined(__NetBSD__)
 470         data.term.c_oflag &= ~OFILL;
 471 #endif
 472         /* Disable canonical mode, and don't echo input characters. */
 473         data.term.c_lflag &= ~(ICANON | ECHO);
 474
 475         /* Ignore modem status lines; enable receiver */
 476         data.term.c_cflag |= (CLOCAL | CREAD);
 477
 478         ret = set_config(port, &data, &config);
 479
 480         if (ret < 0) {
 481                 sp_close(port);
 482                 return ret;
 483         }
 484 #endif
 485
 486         return SP_OK;
 487 }
 488
 489 enum sp_return sp_close(struct sp_port *port)
 490 {
 491         CHECK_PORT();
 492
 493 #ifdef _WIN32
 494         /* Returns non-zero upon success, 0 upon failure. */
 495         if (CloseHandle(port->hdl) == 0)
 496                 return SP_ERR_FAIL;
 497         port->hdl = INVALID_HANDLE_VALUE;
 498 #else
 499         /* Returns 0 upon success, -1 upon failure. */
 500         if (close(port->fd) == -1)
 501                 return SP_ERR_FAIL;
 502         port->fd = -1;
 503 #endif
 504
 505         return SP_OK;
 506 }
 507
 508 enum sp_return sp_flush(struct sp_port *port)
 509 {
 510         CHECK_PORT();
 511
 512 #ifdef _WIN32
 513         /* Returns non-zero upon success, 0 upon failure. */
 514         if (PurgeComm(port->hdl, PURGE_RXCLEAR | PURGE_TXCLEAR) == 0)
 515                 return SP_ERR_FAIL;
 516 #else
 517         /* Returns 0 upon success, -1 upon failure. */
 518         if (tcflush(port->fd, TCIOFLUSH) < 0)
 519                 return SP_ERR_FAIL;
 520 #endif
 521         return SP_OK;
 522 }
 523
 524 enum sp_return sp_write(struct sp_port *port, const void *buf, size_t count)
 525 {
 526         CHECK_PORT();
 527
 528         if (!buf)
 529                 return SP_ERR_ARG;
 530
 531 #ifdef _WIN32
 532         DWORD written = 0;
 533
 534         /* Returns non-zero upon success, 0 upon failure. */
 535         if (WriteFile(port->hdl, buf, count, &written, NULL) == 0)
 536                 return SP_ERR_FAIL;
 537         return written;
 538 #else
 539         /* Returns the number of bytes written, or -1 upon failure. */
 540         ssize_t written = write(port->fd, buf, count);
 541
 542         if (written < 0)
 543                 return SP_ERR_FAIL;
 544         else
 545                 return written;
 546 #endif
 547 }
 548
 549 enum sp_return sp_read(struct sp_port *port, void *buf, size_t count)
 550 {
 551         CHECK_PORT();
 552
 553         if (!buf)
 554                 return SP_ERR_ARG;
 555
 556 #ifdef _WIN32
 557         DWORD bytes_read = 0;
 558
 559         /* Returns non-zero upon success, 0 upon failure. */
 560         if (ReadFile(port->hdl, buf, count, &bytes_read, NULL) == 0)
 561                 return SP_ERR_FAIL;
 562         return bytes_read;
 563 #else
 564         ssize_t bytes_read;
 565
 566         /* Returns the number of bytes read, or -1 upon failure. */
 567         if ((bytes_read = read(port->fd, buf, count)) < 0)
 568                 return SP_ERR_FAIL;
 569         return bytes_read;
 570 #endif
 571 }
 572
 573 #ifdef __linux__
 574 static enum sp_return get_baudrate(int fd, int *baudrate)
 575 {
 576         void *data;
 577
 578         if (!(data = malloc(get_termios_size())))
 579                 return SP_ERR_MEM;
 580
 581         if (ioctl(fd, get_termios_get_ioctl(), data) < 0)
 582                 return SP_ERR_FAIL;
 583
 584         *baudrate = get_termios_speed(data);
 585
 586         return SP_OK;
 587 }
 588
 589 static enum sp_return set_baudrate(int fd, int baudrate)
 590 {
 591         void *data;
 592
 593         if (!(data = malloc(get_termios_size())))
 594                 return SP_ERR_MEM;
 595
 596         if (ioctl(fd, get_termios_get_ioctl(), data) < 0)
 597                 return SP_ERR_FAIL;
 598
 599         set_termios_speed(data, baudrate);
 600
 601         if (ioctl(fd, get_termios_set_ioctl(), data) < 0)
 602                 return SP_ERR_FAIL;
 603
 604         return SP_OK;
 605 }
 606
 607 #ifdef USE_TERMIOX
 608 static enum sp_return get_flow(int fd, int *flow)
 609 {
 610         void *data;
 611
 612         if (!(data = malloc(get_termiox_size())))
 613                 return SP_ERR_MEM;
 614
 615         if (ioctl(fd, TCGETX, data) < 0)
 616                 return SP_ERR_FAIL;
 617
 618         *flow = get_termiox_flow(data);
 619
 620         return SP_OK;
 621 }
 622
 623 static enum sp_return set_flow(int fd, int flow)
 624 {
 625         void *data;
 626
 627         if (!(data = malloc(get_termiox_size())))
 628                 return SP_ERR_MEM;
 629
 630         if (ioctl(fd, TCGETX, data) < 0)
 631                 return SP_ERR_FAIL;
 632
 633         set_termiox_flow(data, flow);
 634
 635         if (ioctl(fd, TCSETX, data) < 0)
 636                 return SP_ERR_FAIL;
 637
 638         return SP_OK;
 639 }
 640 #endif /* USE_TERMIOX */
 641 #endif /* __linux__ */
 642
 643 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
 644         struct sp_port_config *config)
 645 {
 646         unsigned int i;
 647
 648 #ifdef _WIN32
 649         if (!GetCommState(port->hdl, &data->dcb))
 650                 return SP_ERR_FAIL;
 651
 652         for (i = 0; i < NUM_STD_BAUDRATES; i++) {
 653                 if (data->dcb.BaudRate == std_baudrates[i].index) {
 654                         config->baudrate = std_baudrates[i].value;
 655                         break;
 656                 }
 657         }
 658
 659         if (i == NUM_STD_BAUDRATES)
 660                 /* BaudRate field can be either an index or a custom baud rate. */
 661                 config->baudrate = data->dcb.BaudRate;
 662
 663         config->bits = data->dcb.ByteSize;
 664
 665         if (data->dcb.fParity)
 666                 switch (data->dcb.Parity) {
 667                 case NOPARITY:
 668                         config->parity = SP_PARITY_NONE;
 669                         break;
 670                 case EVENPARITY:
 671                         config->parity = SP_PARITY_EVEN;
 672                         break;
 673                 case ODDPARITY:
 674                         config->parity = SP_PARITY_ODD;
 675                         break;
 676                 default:
 677                         config->parity = -1;
 678                 }
 679         else
 680                 config->parity = SP_PARITY_NONE;
 681
 682         switch (data->dcb.StopBits) {
 683         case ONESTOPBIT:
 684                 config->stopbits = 1;
 685                 break;
 686         case TWOSTOPBITS:
 687                 config->stopbits = 2;
 688                 break;
 689         default:
 690                 config->stopbits = -1;
 691         }
 692
 693         switch (data->dcb.fRtsControl) {
 694         case RTS_CONTROL_DISABLE:
 695                 config->rts = SP_RTS_OFF;
 696                 break;
 697         case RTS_CONTROL_ENABLE:
 698                 config->rts = SP_RTS_ON;
 699                 break;
 700         case RTS_CONTROL_HANDSHAKE:
 701                 config->rts = SP_RTS_FLOW_CONTROL;
 702                 break;
 703         default:
 704                 config->rts = -1;
 705         }
 706
 707         config->cts = data->dcb.fOutxCtsFlow ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
 708
 709         switch (data->dcb.fDtrControl) {
 710         case DTR_CONTROL_DISABLE:
 711                 config->dtr = SP_DTR_OFF;
 712                 break;
 713         case DTR_CONTROL_ENABLE:
 714                 config->dtr = SP_DTR_ON;
 715                 break;
 716         case DTR_CONTROL_HANDSHAKE:
 717                 config->dtr = SP_DTR_FLOW_CONTROL;
 718                 break;
 719         default:
 720                 config->dtr = -1;
 721         }
 722
 723         config->dsr = data->dcb.fOutxDsrFlow ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
 724
 725         if (data->dcb.fInX) {
 726                 if (data->dcb.fOutX)
 727                         config->xon_xoff = SP_XONXOFF_INOUT;
 728                 else
 729                         config->xon_xoff = SP_XONXOFF_IN;
 730         } else {
 731                 if (data->dcb.fOutX)
 732                         config->xon_xoff = SP_XONXOFF_OUT;
 733                 else
 734                         config->xon_xoff = SP_XONXOFF_DISABLED;
 735         }
 736
 737 #else // !_WIN32
 738
 739         if (tcgetattr(port->fd, &data->term) < 0)
 740                 return SP_ERR_FAIL;
 741
 742         if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0)
 743                 return SP_ERR_FAIL;
 744
 745 #ifdef USE_TERMIOX
 746         TRY(get_flow(port->fd, &data->flow));
 747 #endif
 748
 749         for (i = 0; i < NUM_STD_BAUDRATES; i++) {
 750                 if (cfgetispeed(&data->term) == std_baudrates[i].index) {
 751                         config->baudrate = std_baudrates[i].value;
 752                         break;
 753                 }
 754         }
 755
 756         if (i == NUM_STD_BAUDRATES) {
 757 #ifdef __APPLE__
 758                 config->baudrate = (int)data->term.c_ispeed;
 759 #elif defined(__linux__)
 760                 TRY(get_baudrate(port->fd, &config->baudrate));
 761 #else
 762                 config->baudrate = -1;
 763 #endif
 764         }
 765
 766         switch (data->term.c_cflag & CSIZE) {
 767         case CS8:
 768                 config->bits = 8;
 769                 break;
 770         case CS7:
 771                 config->bits = 7;
 772                 break;
 773         case CS6:
 774                 config->bits = 6;
 775                 break;
 776         case CS5:
 777                 config->bits = 5;
 778                 break;
 779         default:
 780                 config->bits = -1;
 781         }
 782
 783         if (!(data->term.c_cflag & PARENB) && (data->term.c_iflag & IGNPAR))
 784                 config->parity = SP_PARITY_NONE;
 785         else if (!(data->term.c_cflag & PARENB) || (data->term.c_iflag & IGNPAR))
 786                 config->parity = -1;
 787         else
 788                 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_ODD : SP_PARITY_EVEN;
 789
 790         config->stopbits = (data->term.c_cflag & CSTOPB) ? 2 : 1;
 791
 792         if (data->term.c_cflag & CRTSCTS) {
 793                 config->rts = SP_RTS_FLOW_CONTROL;
 794                 config->cts = SP_CTS_FLOW_CONTROL;
 795         } else {
 796 #ifdef USE_TERMIOX
 797                 if (data->flow & RTS_FLOW)
 798                         config->rts = SP_RTS_FLOW_CONTROL;
 799                 else
 800                         config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
 801
 802                 config->cts = (data->flow & CTS_FLOW) ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
 803 #else
 804                 config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
 805                 config->cts = SP_CTS_IGNORE;
 806 #endif
 807         }
 808
 809 #ifdef USE_TERMIOX
 810         if (data->flow & DTR_FLOW)
 811                 config->dtr = SP_DTR_FLOW_CONTROL;
 812         else
 813                 config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
 814
 815         config->dsr = (data->flow & DSR_FLOW) ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
 816 #else
 817         config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
 818         config->dsr = SP_DSR_IGNORE;
 819 #endif
 820
 821         if (data->term.c_iflag & IXOFF) {
 822                 if (data->term.c_iflag & IXON)
 823                         config->xon_xoff = SP_XONXOFF_INOUT;
 824                 else
 825                         config->xon_xoff = SP_XONXOFF_IN;
 826         } else {
 827                 if (data->term.c_iflag & IXON)
 828                         config->xon_xoff = SP_XONXOFF_OUT;
 829                 else
 830                         config->xon_xoff = SP_XONXOFF_DISABLED;
 831         }
 832 #endif
 833
 834         return SP_OK;
 835 }
 836
 837 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
 838         const struct sp_port_config *config)
 839 {
 840         unsigned int i;
 841 #ifdef __APPLE__
 842         BAUD_TYPE baud_nonstd;
 843
 844         baud_nonstd = B0;
 845 #endif
 846 #ifdef __linux__
 847         int baud_nonstd = 0;
 848 #endif
 849
 850 #ifdef _WIN32
 851         if (config->baudrate >= 0) {
 852                 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
 853                         if (config->baudrate == std_baudrates[i].value) {
 854                                 data->dcb.BaudRate = std_baudrates[i].index;
 855                                 break;
 856                         }
 857                 }
 858
 859                 if (i == NUM_STD_BAUDRATES)
 860                         data->dcb.BaudRate = config->baudrate;
 861         }
 862
 863         if (config->bits >= 0)
 864                 data->dcb.ByteSize = config->bits;
 865
 866         if (config->parity >= 0) {
 867                 switch (config->parity) {
 868                 /* Note: There's also SPACEPARITY, MARKPARITY (unneeded so far). */
 869                 case SP_PARITY_NONE:
 870                         data->dcb.Parity = NOPARITY;
 871                         break;
 872                 case SP_PARITY_EVEN:
 873                         data->dcb.Parity = EVENPARITY;
 874                         break;
 875                 case SP_PARITY_ODD:
 876                         data->dcb.Parity = ODDPARITY;
 877                         break;
 878                 default:
 879                         return SP_ERR_ARG;
 880                 }
 881         }
 882
 883         if (config->stopbits >= 0) {
 884                 switch (config->stopbits) {
 885                 /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
 886                 case 1:
 887                         data->dcb.StopBits = ONESTOPBIT;
 888                         break;
 889                 case 2:
 890                         data->dcb.StopBits = TWOSTOPBITS;
 891                         break;
 892                 default:
 893                         return SP_ERR_ARG;
 894                 }
 895         }
 896
 897         if (config->rts >= 0) {
 898                 switch (config->rts) {
 899                 case SP_RTS_OFF:
 900                         data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
 901                         break;
 902                 case SP_RTS_ON:
 903                         data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
 904                         break;
 905                 case SP_RTS_FLOW_CONTROL:
 906                         data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
 907                         break;
 908                 default:
 909                         return SP_ERR_ARG;
 910                 }
 911         }
 912
 913         if (config->cts >= 0) {
 914                 switch (config->cts) {
 915                 case SP_CTS_IGNORE:
 916                         data->dcb.fOutxCtsFlow = FALSE;
 917                         break;
 918                 case SP_CTS_FLOW_CONTROL:
 919                         data->dcb.fOutxCtsFlow = TRUE;
 920                         break;
 921                 default:
 922                         return SP_ERR_ARG;
 923                 }
 924         }
 925
 926         if (config->dtr >= 0) {
 927                 switch (config->dtr) {
 928                 case SP_DTR_OFF:
 929                         data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
 930                         break;
 931                 case SP_DTR_ON:
 932                         data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
 933                         break;
 934                 case SP_DTR_FLOW_CONTROL:
 935                         data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
 936                         break;
 937                 default:
 938                         return SP_ERR_ARG;
 939                 }
 940         }
 941
 942         if (config->dsr >= 0) {
 943                 switch (config->dsr) {
 944                 case SP_DSR_IGNORE:
 945                         data->dcb.fOutxDsrFlow = FALSE;
 946                         break;
 947                 case SP_DSR_FLOW_CONTROL:
 948                         data->dcb.fOutxDsrFlow = TRUE;
 949                         break;
 950                 default:
 951                         return SP_ERR_ARG;
 952                 }
 953         }
 954
 955         if (config->xon_xoff >= 0) {
 956                 switch (config->xon_xoff) {
 957                 case SP_XONXOFF_DISABLED:
 958                         data->dcb.fInX = FALSE;
 959                         data->dcb.fOutX = FALSE;
 960                         break;
 961                 case SP_XONXOFF_IN:
 962                         data->dcb.fInX = TRUE;
 963                         data->dcb.fOutX = FALSE;
 964                         break;
 965                 case SP_XONXOFF_OUT:
 966                         data->dcb.fInX = FALSE;
 967                         data->dcb.fOutX = TRUE;
 968                         break;
 969                 case SP_XONXOFF_INOUT:
 970                         data->dcb.fInX = TRUE;
 971                         data->dcb.fOutX = TRUE;
 972                         break;
 973                 default:
 974                         return SP_ERR_ARG;
 975                 }
 976         }
 977
 978         if (!SetCommState(port->hdl, &data->dcb))
 979                 return SP_ERR_FAIL;
 980
 981 #else /* !_WIN32 */
 982
 983         int controlbits;
 984
 985         if (config->baudrate >= 0) {
 986                 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
 987                         if (config->baudrate == std_baudrates[i].value) {
 988                                 if (cfsetospeed(&data->term, std_baudrates[i].index) < 0)
 989                                         return SP_ERR_FAIL;
 990
 991                                 if (cfsetispeed(&data->term, std_baudrates[i].index) < 0)
 992                                         return SP_ERR_FAIL;
 993                                 break;
 994                         }
 995                 }
 996
 997                 /* Non-standard baud rate */
 998                 if (i == NUM_STD_BAUDRATES) {
 999 #ifdef __APPLE__
1000                         /* Set "dummy" baud rate */
1001                         if (cfsetspeed(&data->term, B9600) < 0)
1002                                 return SP_ERR_FAIL;
1003                         baud_nonstd = config->baudrate;
1004 #elif defined(__linux__)
1005                         baud_nonstd = 1;
1006 #else
1007                         return SP_ERR_ARG;
1008 #endif
1009                 }
1010         }
1011
1012         if (config->bits >= 0) {
1013                 data->term.c_cflag &= ~CSIZE;
1014                 switch (config->bits) {
1015                 case 8:
1016                         data->term.c_cflag |= CS8;
1017                         break;
1018                 case 7:
1019                         data->term.c_cflag |= CS7;
1020                         break;
1021                 case 6:
1022                         data->term.c_cflag |= CS6;
1023                         break;
1024                 case 5:
1025                         data->term.c_cflag |= CS5;
1026                         break;
1027                 default:
1028                         return SP_ERR_ARG;
1029                 }
1030         }
1031
1032         if (config->parity >= 0) {
1033                 data->term.c_iflag &= ~IGNPAR;
1034                 data->term.c_cflag &= ~(PARENB | PARODD);
1035                 switch (config->parity) {
1036                 case SP_PARITY_NONE:
1037                         data->term.c_iflag |= IGNPAR;
1038                         break;
1039                 case SP_PARITY_EVEN:
1040                         data->term.c_cflag |= PARENB;
1041                         break;
1042                 case SP_PARITY_ODD:
1043                         data->term.c_cflag |= PARENB | PARODD;
1044                         break;
1045                 default:
1046                         return SP_ERR_ARG;
1047                 }
1048         }
1049
1050         if (config->stopbits >= 0) {
1051                 data->term.c_cflag &= ~CSTOPB;
1052                 switch (config->stopbits) {
1053                 case 1:
1054                         data->term.c_cflag &= ~CSTOPB;
1055                         break;
1056                 case 2:
1057                         data->term.c_cflag |= CSTOPB;
1058                         break;
1059                 default:
1060                         return SP_ERR_ARG;
1061                 }
1062         }
1063
1064         if (config->rts >= 0 || config->cts >= 0) {
1065 #ifdef USE_TERMIOX
1066                 data->flow &= ~(RTS_FLOW | CTS_FLOW);
1067                 switch (config->rts) {
1068                         case SP_RTS_OFF:
1069                         case SP_RTS_ON:
1070                                 controlbits = TIOCM_RTS;
1071                                 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
1072                                                 &controlbits) < 0)
1073                                         return SP_ERR_FAIL;
1074                                 break;
1075                         case SP_RTS_FLOW_CONTROL:
1076                                 data->flow |= RTS_FLOW;
1077                                 break;
1078                         default:
1079                                 break;
1080                 }
1081                 if (config->cts == SP_CTS_FLOW_CONTROL)
1082                         data->flow |= CTS_FLOW;
1083
1084                 if (data->flow & (RTS_FLOW | CTS_FLOW))
1085                         data->term.c_iflag |= CRTSCTS;
1086                 else
1087                         data->term.c_iflag &= ~CRTSCTS;
1088 #else
1089                 /* Asymmetric use of RTS/CTS not supported. */
1090                 if (data->term.c_iflag & CRTSCTS) {
1091                         /* Flow control can only be disabled for both RTS & CTS together. */
1092                         if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) {
1093                                 if (config->cts != SP_CTS_IGNORE)
1094                                         return SP_ERR_ARG;
1095                         }
1096                         if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) {
1097                                 if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL)
1098                                         return SP_ERR_ARG;
1099                         }
1100                 } else {
1101                         /* Flow control can only be enabled for both RTS & CTS together. */
1102                         if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) ||
1103                                 ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL)))
1104                                 return SP_ERR_ARG;
1105                 }
1106
1107                 if (config->rts >= 0) {
1108                         if (config->rts == SP_RTS_FLOW_CONTROL) {
1109                                 data->term.c_iflag |= CRTSCTS;
1110                         } else {
1111                                 controlbits = TIOCM_RTS;
1112                                 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
1113                                                 &controlbits) < 0)
1114                                         return SP_ERR_FAIL;
1115                         }
1116                 }
1117 #endif
1118         }
1119
1120         if (config->dtr >= 0 || config->dsr >= 0) {
1121 #ifdef USE_TERMIOX
1122                 data->flow &= ~(DTR_FLOW | DSR_FLOW);
1123                 switch (config->dtr) {
1124                         case SP_DTR_OFF:
1125                         case SP_DTR_ON:
1126                                 controlbits = TIOCM_DTR;
1127                                 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
1128                                                 &controlbits) < 0)
1129                                         return SP_ERR_FAIL;
1130                                 break;
1131                         case SP_DTR_FLOW_CONTROL:
1132                                 data->flow |= DTR_FLOW;
1133                                 break;
1134                         default:
1135                                 break;
1136                 }
1137                 if (config->dsr == SP_DSR_FLOW_CONTROL)
1138                         data->flow |= DSR_FLOW;
1139 #else
1140                 /* DTR/DSR flow control not supported. */
1141                 if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
1142                         return SP_ERR_ARG;
1143
1144                 if (config->dtr >= 0) {
1145                         controlbits = TIOCM_DTR;
1146                         if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
1147                                         &controlbits) < 0)
1148                                 return SP_ERR_FAIL;
1149                 }
1150 #endif
1151         }
1152
1153         if (config->xon_xoff >= 0) {
1154                 data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
1155                 switch (config->xon_xoff) {
1156                 case SP_XONXOFF_DISABLED:
1157                         break;
1158                 case SP_XONXOFF_IN:
1159                         data->term.c_iflag |= IXOFF;
1160                         break;
1161                 case SP_XONXOFF_OUT:
1162                         data->term.c_iflag |= IXON | IXANY;
1163                         break;
1164                 case SP_XONXOFF_INOUT:
1165                         data->term.c_iflag |= IXON | IXOFF | IXANY;
1166                         break;
1167                 default:
1168                         return SP_ERR_ARG;
1169                 }
1170         }
1171
1172         if (tcsetattr(port->fd, TCSADRAIN, &data->term) < 0)
1173                 return SP_ERR_FAIL;
1174
1175 #ifdef __APPLE__
1176         if (baud_nonstd != B0) {
1177                 if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1)
1178                         return SP_ERR_FAIL;
1179                 /* Set baud rates in data->term to correct, but incompatible
1180                  * with tcsetattr() value, same as delivered by tcgetattr(). */
1181                 if (cfsetspeed(&data->term, baud_nonstd) < 0)
1182                         return SP_ERR_FAIL;
1183         }
1184 #elif defined(__linux__)
1185         if (baud_nonstd)
1186                 TRY(set_baudrate(port->fd, config->baudrate));
1187 #ifdef USE_TERMIOX
1188         TRY(set_flow(port->fd, data->flow));
1189 #endif
1190 #endif
1191
1192 #endif /* !_WIN32 */
1193
1194         return SP_OK;
1195 }
1196
1197 enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *config)
1198 {
1199         struct port_data data;
1200         struct sp_port_config prev_config;
1201
1202         CHECK_PORT();
1203
1204         if (!config)
1205                 return SP_ERR_ARG;
1206
1207         TRY(get_config(port, &data, &prev_config));
1208         TRY(set_config(port, &data, config));
1209
1210         return SP_OK;
1211 }
1212
1213 #define CREATE_SETTER(x, type) int sp_set_##x(struct sp_port *port, type x) { \
1214         struct port_data data; \
1215         struct sp_port_config config; \
1216         CHECK_PORT(); \
1217         TRY(get_config(port, &data, &config)); \
1218         config.x = x; \
1219         TRY(set_config(port, &data, &config)); \
1220         return SP_OK; \
1221 }
1222
1223 CREATE_SETTER(baudrate, int)
1224 CREATE_SETTER(bits, int)
1225 CREATE_SETTER(parity, enum sp_parity)
1226 CREATE_SETTER(stopbits, int)
1227 CREATE_SETTER(rts, enum sp_rts)
1228 CREATE_SETTER(cts, enum sp_cts)
1229 CREATE_SETTER(dtr, enum sp_dtr)
1230 CREATE_SETTER(dsr, enum sp_dsr)
1231 CREATE_SETTER(xon_xoff, enum sp_xonxoff)
1232
1233 enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol)
1234 {
1235         struct port_data data;
1236         struct sp_port_config config;
1237
1238         CHECK_PORT();
1239
1240         TRY(get_config(port, &data, &config));
1241
1242         if (flowcontrol == SP_FLOWCONTROL_XONXOFF)
1243                 config.xon_xoff = SP_XONXOFF_INOUT;
1244         else
1245                 config.xon_xoff = SP_XONXOFF_DISABLED;
1246
1247         if (flowcontrol == SP_FLOWCONTROL_RTSCTS) {
1248                 config.rts = SP_RTS_FLOW_CONTROL;
1249                 config.cts = SP_CTS_FLOW_CONTROL;
1250         } else {
1251                 if (config.rts == SP_RTS_FLOW_CONTROL)
1252                         config.rts = SP_RTS_ON;
1253                 config.cts = SP_CTS_IGNORE;
1254         }
1255
1256         if (flowcontrol == SP_FLOWCONTROL_DTRDSR) {
1257                 config.dtr = SP_DTR_FLOW_CONTROL;
1258                 config.dsr = SP_DSR_FLOW_CONTROL;
1259         } else {
1260                 if (config.dtr == SP_DTR_FLOW_CONTROL)
1261                         config.dtr = SP_DTR_ON;
1262                 config.dsr = SP_DSR_IGNORE;
1263         }
1264
1265         TRY(set_config(port, &data, &config));
1266
1267         return SP_OK;
1268 }
1269
1270 int sp_last_error_code(void)
1271 {
1272 #ifdef _WIN32
1273         return GetLastError();
1274 #else
1275         return errno;
1276 #endif
1277 }
1278
1279 char *sp_last_error_message(void)
1280 {
1281 #ifdef _WIN32
1282         LPVOID message;
1283         DWORD error = GetLastError();
1284
1285         FormatMessage(
1286                 FORMAT_MESSAGE_ALLOCATE_BUFFER |
1287                 FORMAT_MESSAGE_FROM_SYSTEM |
1288                 FORMAT_MESSAGE_IGNORE_INSERTS,
1289                 NULL,
1290                 error,
1291                 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
1292                 (LPTSTR) &message,
1293                 0, NULL );
1294
1295         return message;
1296 #else
1297         return strerror(errno);
1298 #endif
1299 }
1300
1301 void sp_free_error_message(char *message)
1302 {
1303 #ifdef _WIN32
1304         LocalFree(message);
1305 #else
1306         (void)message;
1307 #endif
1308 }