2 * This file is part of the libserialport project.
4 * Copyright (C) 2014 Martin Ling <martin-libserialport@earth.li>
5 * Copyright (C) 2014 Aurelien Jacobs <aurel@gnuage.org>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Lesser General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #define _BSD_SOURCE // for timeradd, timersub, timercmp
26 #include <sys/types.h>
43 #include <sys/ioctl.h>
49 #include <CoreFoundation/CoreFoundation.h>
50 #include <IOKit/IOKitLib.h>
51 #include <IOKit/serial/IOSerialKeys.h>
52 #include <IOKit/serial/ioss.h>
53 #include <sys/syslimits.h>
58 #include "linux/serial.h"
60 #include "linux_termios.h"
62 /* TCGETX/TCSETX is not available everywhere. */
63 #if defined(TCGETX) && defined(TCSETX) && defined(HAVE_TERMIOX)
68 /* TIOCINQ/TIOCOUTQ is not available everywhere. */
69 #if !defined(TIOCINQ) && defined(FIONREAD)
70 #define TIOCINQ FIONREAD
72 #if !defined(TIOCOUTQ) && defined(FIONWRITE)
73 #define TIOCOUTQ FIONWRITE
76 /* Non-standard baudrates are not available everywhere. */
77 #if defined(HAVE_TERMIOS_SPEED) || defined(HAVE_TERMIOS2_SPEED)
78 #define USE_TERMIOS_SPEED
84 enum sp_transport transport;
89 char *usb_manufacturer;
92 char *bluetooth_address;
96 COMMTIMEOUTS timeouts;
108 struct sp_port_config {
111 enum sp_parity parity;
117 enum sp_xonxoff xon_xoff;
126 int termiox_supported;
135 typedef HANDLE event_handle;
137 typedef int event_handle;
140 /* Standard baud rates. */
142 #define BAUD_TYPE DWORD
143 #define BAUD(n) {CBR_##n, n}
145 #define BAUD_TYPE speed_t
146 #define BAUD(n) {B##n, n}
149 struct std_baudrate {
154 extern const struct std_baudrate std_baudrates[];
156 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
157 #define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates)
159 extern void (*sp_debug_handler)(const char *format, ...);
161 /* Debug output macros. */
162 #define DEBUG_FMT(fmt, ...) do { \
163 if (sp_debug_handler) \
164 sp_debug_handler(fmt ".\n", __VA_ARGS__); \
166 #define DEBUG(msg) DEBUG_FMT(msg, NULL)
167 #define DEBUG_ERROR(err, msg) DEBUG_FMT("%s returning " #err ": " msg, __func__)
168 #define DEBUG_FAIL(msg) do { \
169 char *errmsg = sp_last_error_message(); \
170 DEBUG_FMT("%s returning SP_ERR_FAIL: " msg ": %s", __func__, errmsg); \
171 sp_free_error_message(errmsg); \
173 #define RETURN() do { \
174 DEBUG_FMT("%s returning", __func__); \
177 #define RETURN_CODE(x) do { \
178 DEBUG_FMT("%s returning " #x, __func__); \
181 #define RETURN_CODEVAL(x) do { \
183 case SP_OK: RETURN_CODE(SP_OK); \
184 case SP_ERR_ARG: RETURN_CODE(SP_ERR_ARG); \
185 case SP_ERR_FAIL: RETURN_CODE(SP_ERR_FAIL); \
186 case SP_ERR_MEM: RETURN_CODE(SP_ERR_MEM); \
187 case SP_ERR_SUPP: RETURN_CODE(SP_ERR_SUPP); \
190 #define RETURN_OK() RETURN_CODE(SP_OK);
191 #define RETURN_ERROR(err, msg) do { \
192 DEBUG_ERROR(err, msg); \
195 #define RETURN_FAIL(msg) do { \
197 return SP_ERR_FAIL; \
199 #define RETURN_INT(x) do { \
201 DEBUG_FMT("%s returning %d", __func__, _x); \
204 #define RETURN_STRING(x) do { \
206 DEBUG_FMT("%s returning %s", __func__, _x); \
209 #define RETURN_POINTER(x) do { \
211 DEBUG_FMT("%s returning %p", __func__, _x); \
214 #define SET_ERROR(val, err, msg) do { DEBUG_ERROR(err, msg); val = err; } while (0)
215 #define SET_FAIL(val, msg) do { DEBUG_FAIL(msg); val = SP_ERR_FAIL; } while (0)
216 #define TRACE(fmt, ...) DEBUG_FMT("%s(" fmt ") called", __func__, __VA_ARGS__)
217 #define TRACE_VOID() DEBUG_FMT("%s() called", __func__)
219 #define TRY(x) do { int ret = x; if (ret != SP_OK) RETURN_CODEVAL(ret); } while (0)
221 SP_PRIV struct sp_port **list_append(struct sp_port **list, const char *portname);
223 /* OS-specific Helper functions. */
224 SP_PRIV enum sp_return get_port_details(struct sp_port *port);
225 SP_PRIV enum sp_return list_ports(struct sp_port ***list);