/* * This file is part of the libserialport project. * * Copyright (C) 2014 Martin Ling * Copyright (C) 2014 Aurelien Jacobs * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this program. If not, see . */ #ifndef LIBSERIALPORT_LIBSERIALPORT_INTERNAL_H #define LIBSERIALPORT_LIBSERIALPORT_INTERNAL_H #ifdef __linux__ /* For timeradd, timersub, timercmp, realpath. */ #define _BSD_SOURCE 1 /* for glibc < 2.19 */ #define _DEFAULT_SOURCE 1 /* for glibc >= 2.20 */ #endif #include #include #include #include #include #include #include #include #include #ifdef _WIN32 #include #include #include #include #undef DEFINE_GUID #define DEFINE_GUID(name,l,w1,w2,b1,b2,b3,b4,b5,b6,b7,b8) \ static const GUID name = { l,w1,w2,{ b1,b2,b3,b4,b5,b6,b7,b8 } } #include #include #else #include #include #include #include #include #endif #ifdef __APPLE__ #include #include #include #include #include #endif #ifdef __linux__ #include #ifndef __ANDROID__ #include "linux/serial.h" #endif #include "linux_termios.h" /* TCGETX/TCSETX is not available everywhere. */ #if defined(TCGETX) && defined(TCSETX) && defined(HAVE_STRUCT_TERMIOX) #define USE_TERMIOX #endif #endif /* TIOCINQ/TIOCOUTQ is not available everywhere. */ #if !defined(TIOCINQ) && defined(FIONREAD) #define TIOCINQ FIONREAD #endif #if !defined(TIOCOUTQ) && defined(FIONWRITE) #define TIOCOUTQ FIONWRITE #endif /* Non-standard baudrates are not available everywhere. */ #if (defined(HAVE_TERMIOS_SPEED) || defined(HAVE_TERMIOS2_SPEED)) && HAVE_DECL_BOTHER #define USE_TERMIOS_SPEED #endif struct sp_port { char *name; char *description; enum sp_transport transport; int usb_bus; int usb_address; int usb_vid; int usb_pid; char *usb_manufacturer; char *usb_product; char *usb_serial; char *bluetooth_address; #ifdef _WIN32 char *usb_path; HANDLE hdl; COMMTIMEOUTS timeouts; OVERLAPPED write_ovl; OVERLAPPED read_ovl; OVERLAPPED wait_ovl; DWORD events; BYTE pending_byte; BOOL writing; BOOL wait_running; #else int fd; #endif }; struct sp_port_config { int baudrate; int bits; enum sp_parity parity; int stopbits; enum sp_rts rts; enum sp_cts cts; enum sp_dtr dtr; enum sp_dsr dsr; enum sp_xonxoff xon_xoff; }; struct port_data { #ifdef _WIN32 DCB dcb; #else struct termios term; int controlbits; int termiox_supported; int rts_flow; int cts_flow; int dtr_flow; int dsr_flow; #endif }; #ifdef _WIN32 typedef HANDLE event_handle; #else typedef int event_handle; #endif /* Standard baud rates. */ #ifdef _WIN32 #define BAUD_TYPE DWORD #define BAUD(n) {CBR_##n, n} #else #define BAUD_TYPE speed_t #define BAUD(n) {B##n, n} #endif struct std_baudrate { BAUD_TYPE index; int value; }; #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0])) extern void (*sp_debug_handler)(const char *format, ...); /* Debug output macros. */ #define DEBUG_FMT(fmt, ...) do { \ if (sp_debug_handler) \ sp_debug_handler(fmt ".\n", __VA_ARGS__); \ } while (0) #define DEBUG(msg) DEBUG_FMT(msg, NULL) #define DEBUG_ERROR(err, msg) DEBUG_FMT("%s returning " #err ": " msg, __func__) #define DEBUG_FAIL(msg) do { \ char *errmsg = sp_last_error_message(); \ DEBUG_FMT("%s returning SP_ERR_FAIL: " msg ": %s", __func__, errmsg); \ sp_free_error_message(errmsg); \ } while (0); #define RETURN() do { \ DEBUG_FMT("%s returning", __func__); \ return; \ } while (0) #define RETURN_CODE(x) do { \ DEBUG_FMT("%s returning " #x, __func__); \ return x; \ } while (0) #define RETURN_CODEVAL(x) do { \ switch (x) { \ case SP_OK: RETURN_CODE(SP_OK); \ case SP_ERR_ARG: RETURN_CODE(SP_ERR_ARG); \ case SP_ERR_FAIL: RETURN_CODE(SP_ERR_FAIL); \ case SP_ERR_MEM: RETURN_CODE(SP_ERR_MEM); \ case SP_ERR_SUPP: RETURN_CODE(SP_ERR_SUPP); \ default: RETURN_CODE(SP_ERR_FAIL); \ } \ } while (0) #define RETURN_OK() RETURN_CODE(SP_OK); #define RETURN_ERROR(err, msg) do { \ DEBUG_ERROR(err, msg); \ return err; \ } while (0) #define RETURN_FAIL(msg) do { \ DEBUG_FAIL(msg); \ return SP_ERR_FAIL; \ } while (0) #define RETURN_INT(x) do { \ int _x = x; \ DEBUG_FMT("%s returning %d", __func__, _x); \ return _x; \ } while (0) #define RETURN_STRING(x) do { \ char *_x = x; \ DEBUG_FMT("%s returning %s", __func__, _x); \ return _x; \ } while (0) #define RETURN_POINTER(x) do { \ void *_x = x; \ DEBUG_FMT("%s returning %p", __func__, _x); \ return _x; \ } while (0) #define SET_ERROR(val, err, msg) do { DEBUG_ERROR(err, msg); val = err; } while (0) #define SET_FAIL(val, msg) do { DEBUG_FAIL(msg); val = SP_ERR_FAIL; } while (0) #define TRACE(fmt, ...) DEBUG_FMT("%s(" fmt ") called", __func__, __VA_ARGS__) #define TRACE_VOID() DEBUG_FMT("%s() called", __func__) #define TRY(x) do { int retval = x; if (retval != SP_OK) RETURN_CODEVAL(retval); } while (0) SP_PRIV struct sp_port **list_append(struct sp_port **list, const char *portname); /* OS-specific Helper functions. */ SP_PRIV enum sp_return get_port_details(struct sp_port *port); SP_PRIV enum sp_return list_ports(struct sp_port ***list); #endif