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/>.
21 #ifndef LIBSERIALPORT_LIBSERIALPORT_INTERNAL_H
22 #define LIBSERIALPORT_LIBSERIALPORT_INTERNAL_H
26 /* For timeradd, timersub, timercmp, realpath. */
27 #define _BSD_SOURCE 1 /* for glibc < 2.19 */
28 #define _DEFAULT_SOURCE 1 /* for glibc >= 2.20 */
32 #include <sys/types.h>
46 #define DEFINE_GUID(name,l,w1,w2,b1,b2,b3,b4,b5,b6,b7,b8) \
47 static const GUID name = { l,w1,w2,{ b1,b2,b3,b4,b5,b6,b7,b8 } }
53 #include <sys/ioctl.h>
58 #include <CoreFoundation/CoreFoundation.h>
59 #include <IOKit/IOKitLib.h>
60 #include <IOKit/serial/IOSerialKeys.h>
61 #include <IOKit/serial/ioss.h>
62 #include <sys/syslimits.h>
67 #include "linux/serial.h"
69 #include "linux_termios.h"
71 /* TCGETX/TCSETX is not available everywhere. */
72 #if defined(TCGETX) && defined(TCSETX) && defined(HAVE_STRUCT_TERMIOX)
77 /* TIOCINQ/TIOCOUTQ is not available everywhere. */
78 #if !defined(TIOCINQ) && defined(FIONREAD)
79 #define TIOCINQ FIONREAD
81 #if !defined(TIOCOUTQ) && defined(FIONWRITE)
82 #define TIOCOUTQ FIONWRITE
85 /* Non-standard baudrates are not available everywhere. */
86 #if (defined(HAVE_TERMIOS_SPEED) || defined(HAVE_TERMIOS2_SPEED)) && HAVE_DECL_BOTHER
87 #define USE_TERMIOS_SPEED
93 enum sp_transport transport;
98 char *usb_manufacturer;
101 char *bluetooth_address;
105 COMMTIMEOUTS timeouts;
106 OVERLAPPED write_ovl;
111 DWORD write_buf_size;
119 struct sp_port_config {
122 enum sp_parity parity;
128 enum sp_xonxoff xon_xoff;
137 int termiox_supported;
146 typedef HANDLE event_handle;
148 typedef int event_handle;
151 /* Standard baud rates. */
153 #define BAUD_TYPE DWORD
154 #define BAUD(n) {CBR_##n, n}
156 #define BAUD_TYPE speed_t
157 #define BAUD(n) {B##n, n}
160 struct std_baudrate {
165 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
167 extern void (*sp_debug_handler)(const char *format, ...);
169 /* Debug output macros. */
170 #define DEBUG_FMT(fmt, ...) do { \
171 if (sp_debug_handler) \
172 sp_debug_handler(fmt ".\n", __VA_ARGS__); \
174 #define DEBUG(msg) DEBUG_FMT(msg, NULL)
175 #define DEBUG_ERROR(err, msg) DEBUG_FMT("%s returning " #err ": " msg, __func__)
176 #define DEBUG_FAIL(msg) do { \
177 char *errmsg = sp_last_error_message(); \
178 DEBUG_FMT("%s returning SP_ERR_FAIL: " msg ": %s", __func__, errmsg); \
179 sp_free_error_message(errmsg); \
181 #define RETURN() do { \
182 DEBUG_FMT("%s returning", __func__); \
185 #define RETURN_CODE(x) do { \
186 DEBUG_FMT("%s returning " #x, __func__); \
189 #define RETURN_CODEVAL(x) do { \
191 case SP_OK: RETURN_CODE(SP_OK); \
192 case SP_ERR_ARG: RETURN_CODE(SP_ERR_ARG); \
193 case SP_ERR_FAIL: RETURN_CODE(SP_ERR_FAIL); \
194 case SP_ERR_MEM: RETURN_CODE(SP_ERR_MEM); \
195 case SP_ERR_SUPP: RETURN_CODE(SP_ERR_SUPP); \
196 default: RETURN_CODE(SP_ERR_FAIL); \
199 #define RETURN_OK() RETURN_CODE(SP_OK);
200 #define RETURN_ERROR(err, msg) do { \
201 DEBUG_ERROR(err, msg); \
204 #define RETURN_FAIL(msg) do { \
206 return SP_ERR_FAIL; \
208 #define RETURN_INT(x) do { \
210 DEBUG_FMT("%s returning %d", __func__, _x); \
213 #define RETURN_STRING(x) do { \
215 DEBUG_FMT("%s returning %s", __func__, _x); \
218 #define RETURN_POINTER(x) do { \
220 DEBUG_FMT("%s returning %p", __func__, _x); \
223 #define SET_ERROR(val, err, msg) do { DEBUG_ERROR(err, msg); val = err; } while (0)
224 #define SET_FAIL(val, msg) do { DEBUG_FAIL(msg); val = SP_ERR_FAIL; } while (0)
225 #define TRACE(fmt, ...) DEBUG_FMT("%s(" fmt ") called", __func__, __VA_ARGS__)
226 #define TRACE_VOID() DEBUG_FMT("%s() called", __func__)
228 #define TRY(x) do { int retval = x; if (retval != SP_OK) RETURN_CODEVAL(retval); } while (0)
230 SP_PRIV struct sp_port **list_append(struct sp_port **list, const char *portname);
232 /* OS-specific Helper functions. */
233 SP_PRIV enum sp_return get_port_details(struct sp_port *port);
234 SP_PRIV enum sp_return list_ports(struct sp_port ***list);