]>
Commit | Line | Data |
---|---|---|
74510d4b ML |
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 | ||
f92f1f0c UH |
20 | #ifndef LIBSERIALPORT_H |
21 | #define LIBSERIALPORT_H | |
e8ffaee9 | 22 | |
5ef8a1ed UH |
23 | #ifdef __cplusplus |
24 | extern "C" { | |
25 | #endif | |
26 | ||
74510d4b ML |
27 | #include <stddef.h> |
28 | #ifdef _WIN32 | |
29 | #include <windows.h> | |
30 | #endif | |
31 | ||
baba0759 UH |
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@" | |
36 | ||
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@" | |
42 | ||
74510d4b ML |
43 | /* A serial port. */ |
44 | struct sp_port { | |
45 | /* Name used to open the port */ | |
46 | char *name; | |
47 | /* OS-specific port handle */ | |
48 | #ifdef _WIN32 | |
49 | HANDLE hdl; | |
50 | #else | |
51 | int fd; | |
52 | #endif | |
53 | }; | |
54 | ||
d1202734 ML |
55 | /* Configuration for a serial port. */ |
56 | struct sp_port_config { | |
57 | int baudrate; | |
58 | int bits; | |
59 | int parity; | |
60 | int stopbits; | |
61 | int flowcontrol; | |
62 | int rts; | |
63 | int dtr; | |
64 | }; | |
65 | ||
74510d4b ML |
66 | /* Return values. */ |
67 | enum { | |
68 | /* Operation completed successfully. */ | |
69 | SP_OK = 0, | |
74510d4b | 70 | /* Invalid arguments were passed to the function. */ |
e9a2f9c9 ML |
71 | SP_ERR_ARG = -1, |
72 | /* A system error occured while executing the operation. */ | |
73 | SP_ERR_FAIL = -2, | |
74 | /* A memory allocation failed while executing the operation. */ | |
f92f1f0c | 75 | SP_ERR_MEM = -3, |
74510d4b ML |
76 | }; |
77 | ||
78 | /* Port access modes. */ | |
79 | enum { | |
80 | /* Open port for read/write access. */ | |
81 | SP_MODE_RDWR = 1, | |
82 | /* Open port for read access only. */ | |
83 | SP_MODE_RDONLY = 2, | |
84 | /* Open port in non-blocking mode. */ | |
f92f1f0c | 85 | SP_MODE_NONBLOCK = 4, |
74510d4b ML |
86 | }; |
87 | ||
88 | /* Parity settings. */ | |
89 | enum { | |
90 | /* No parity. */ | |
91 | SP_PARITY_NONE = 0, | |
92 | /* Even parity. */ | |
93 | SP_PARITY_EVEN = 1, | |
94 | /* Odd parity. */ | |
f92f1f0c | 95 | SP_PARITY_ODD = 2, |
74510d4b ML |
96 | }; |
97 | ||
ac74fdaf ML |
98 | /* Flow control settings. */ |
99 | enum { | |
100 | /* No flow control. */ | |
101 | SP_FLOW_NONE = 0, | |
102 | /* Hardware (RTS/CTS) flow control. */ | |
103 | SP_FLOW_HARDWARE = 1, | |
104 | /* Software (XON/XOFF) flow control. */ | |
f92f1f0c | 105 | SP_FLOW_SOFTWARE = 2, |
ac74fdaf ML |
106 | }; |
107 | ||
77f262c4 | 108 | int sp_get_port_by_name(const char *portname, struct sp_port **port_ptr); |
e3b2f7a4 | 109 | void sp_free_port(struct sp_port *port); |
77f262c4 | 110 | int sp_list_ports(struct sp_port ***list_ptr); |
32b5ac05 | 111 | int sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr); |
d54e9004 ML |
112 | void sp_free_port_list(struct sp_port **ports); |
113 | int sp_open(struct sp_port *port, int flags); | |
74510d4b ML |
114 | int sp_close(struct sp_port *port); |
115 | int sp_flush(struct sp_port *port); | |
116 | int sp_write(struct sp_port *port, const void *buf, size_t count); | |
117 | int sp_read(struct sp_port *port, void *buf, size_t count); | |
d1202734 | 118 | int sp_set_config(struct sp_port *port, struct sp_port_config *config); |
74510d4b ML |
119 | int sp_last_error_code(void); |
120 | char *sp_last_error_message(void); | |
121 | void sp_free_error_message(char *message); | |
e8ffaee9 | 122 | |
5ef8a1ed UH |
123 | #ifdef __cplusplus |
124 | } | |
125 | #endif | |
126 | ||
f92f1f0c | 127 | #endif /* LIBSERIALPORT_H */ |