libserialport.h

   1 /*
   2  * This file is part of the libserialport project.
   3  *
   4  * Copyright (C) 2013 Martin Ling <martin-libserialport@earth.li>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Lesser General Public License as
   8  * published by the Free Software Foundation, either version 3 of the
   9  * License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef LIBSERIALPORT_H
  21 #define LIBSERIALPORT_H
  22
  23 #include <stddef.h>
  24 #ifdef _WIN32
  25 #include <windows.h>
  26 #endif
  27
  28 /* A serial port. */
  29 struct sp_port {
  30         /* Name used to open the port */
  31         char *name;
  32         /* OS-specific port handle */
  33 #ifdef _WIN32
  34         HANDLE hdl;
  35 #else
  36         int fd;
  37 #endif
  38 };
  39
  40 /* Return values. */
  41 enum {
  42         /* Operation completed successfully. */
  43         SP_OK = 0,
  44         /* Invalid arguments were passed to the function. */
  45         SP_ERR_ARG = -1,
  46         /* A system error occured while executing the operation. */
  47         SP_ERR_FAIL = -2,
  48         /* A memory allocation failed while executing the operation. */
  49         SP_ERR_MEM = -3,
  50 };
  51
  52 /* Port access modes. */
  53 enum {
  54         /* Open port for read/write access. */
  55         SP_MODE_RDWR = 1,
  56         /* Open port for read access only. */
  57         SP_MODE_RDONLY = 2,
  58         /* Open port in non-blocking mode. */
  59         SP_MODE_NONBLOCK = 4,
  60 };
  61
  62 /* Parity settings. */
  63 enum {
  64         /* No parity. */
  65         SP_PARITY_NONE = 0,
  66         /* Even parity. */
  67         SP_PARITY_EVEN = 1,
  68         /* Odd parity. */
  69         SP_PARITY_ODD = 2,
  70 };
  71
  72 /* Flow control settings. */
  73 enum {
  74         /* No flow control. */
  75         SP_FLOW_NONE = 0,
  76         /* Hardware (RTS/CTS) flow control. */
  77         SP_FLOW_HARDWARE = 1,
  78         /* Software (XON/XOFF) flow control. */
  79         SP_FLOW_SOFTWARE = 2,
  80 };
  81
  82 int sp_get_port_by_name(const char *portname, struct sp_port **port_ptr);
  83 void sp_free_port(struct sp_port *port);
  84 int sp_list_ports(struct sp_port ***list_ptr);
  85 int sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr);
  86 void sp_free_port_list(struct sp_port **ports);
  87 int sp_open(struct sp_port *port, int flags);
  88 int sp_close(struct sp_port *port);
  89 int sp_flush(struct sp_port *port);
  90 int sp_write(struct sp_port *port, const void *buf, size_t count);
  91 int sp_read(struct sp_port *port, void *buf, size_t count);
  92 int sp_set_params(struct sp_port *port, int baudrate, int bits, int parity,
  93                 int stopbits, int flowcontrol, int rts, int dtr);
  94 int sp_last_error_code(void);
  95 char *sp_last_error_message(void);
  96 void sp_free_error_message(char *message);
  97
  98 #endif /* LIBSERIALPORT_H */