2 * This file is part of the libserialport project.
4 * Copyright (C) 2013 Martin Ling <martin-libserialport@earth.li>
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.
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.
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/>.
20 #ifndef LIBSERIALPORT_H
21 #define LIBSERIALPORT_H
32 /* Package version macros (e.g. for conditional compilation). */
33 #define SP_PACKAGE_VERSION_MAJOR @SP_PACKAGE_VERSION_MAJOR@
34 #define SP_PACKAGE_VERSION_MINOR @SP_PACKAGE_VERSION_MINOR@
35 #define SP_PACKAGE_VERSION_STRING "@SP_PACKAGE_VERSION@"
37 /* Library/libtool version macros (e.g. for conditional compilation). */
38 #define SP_LIB_VERSION_CURRENT @SP_LIB_VERSION_CURRENT@
39 #define SP_LIB_VERSION_REVISION @SP_LIB_VERSION_REVISION@
40 #define SP_LIB_VERSION_AGE @SP_LIB_VERSION_AGE@
41 #define SP_LIB_VERSION_STRING "@SP_LIB_VERSION@"
45 /* Name used to open the port */
47 /* OS-specific port handle */
55 /* Configuration for a serial port. */
56 struct sp_port_config {
71 /* Operation completed successfully. */
73 /* Invalid arguments were passed to the function. */
75 /* A system error occured while executing the operation. */
77 /* A memory allocation failed while executing the operation. */
81 /* Port access modes. */
83 /* Open port for read/write access. */
85 /* Open port for read access only. */
87 /* Open port in non-blocking mode. */
91 /* Parity settings. */
101 /* RTS pin behaviour. */
105 SP_RTS_FLOW_CONTROL = 2
108 /* CTS pin behaviour. */
111 SP_CTS_FLOW_CONTROL = 1
114 /* DTR pin behaviour. */
118 SP_DTR_FLOW_CONTROL = 2
121 /* DSR pin behaviour. */
124 SP_DSR_FLOW_CONTROL = 1
127 /* XON/XOFF flow control behaviour. */
129 SP_XONXOFF_DISABLED = 0,
135 int sp_get_port_by_name(const char *portname, struct sp_port **port_ptr);
136 void sp_free_port(struct sp_port *port);
137 int sp_list_ports(struct sp_port ***list_ptr);
138 int sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr);
139 void sp_free_port_list(struct sp_port **ports);
140 int sp_open(struct sp_port *port, int flags);
141 int sp_close(struct sp_port *port);
142 int sp_flush(struct sp_port *port);
143 int sp_write(struct sp_port *port, const void *buf, size_t count);
144 int sp_read(struct sp_port *port, void *buf, size_t count);
145 int sp_set_config(struct sp_port *port, struct sp_port_config *config);
146 int sp_last_error_code(void);
147 char *sp_last_error_message(void);
148 void sp_free_error_message(char *message);
154 #endif /* LIBSERIALPORT_H */