]> sigrok.org Git - libserialport.git/blobdiff - serialport.c
Add format string support to RETURN_ERROR() and RETURN_FAIL().
[libserialport.git] / serialport.c
index 2adf9357a632adf75da56bf52a147bb275fd3bcb..89fbcec6a3b5ef7f638ba0ee4c2f5b8b69960437 100644 (file)
@@ -70,8 +70,9 @@
 #define TIOCOUTQ FIONWRITE
 #endif
 
-#ifndef _WIN32
-#include "linux_termios.h"
+/* Non-standard baudrates are not available everywhere. */
+#if defined(HAVE_TERMIOS_SPEED) || defined(HAVE_TERMIOS2_SPEED)
+#define USE_TERMIOS_SPEED
 #endif
 
 #include "libserialport.h"
@@ -111,7 +112,10 @@ struct port_data {
        struct termios term;
        int controlbits;
        int termiox_supported;
-       int flow;
+       int rts_flow;
+       int cts_flow;
+       int dtr_flow;
+       int dsr_flow;
 #endif
 };
 
@@ -162,10 +166,10 @@ void (*sp_debug_handler)(const char *format, ...) = sp_default_debug_handler;
 
 /* Debug output macros. */
 #define DEBUG(fmt, ...) do { if (sp_debug_handler) sp_debug_handler(fmt ".\n", ##__VA_ARGS__); } while (0)
-#define DEBUG_ERROR(err, msg) DEBUG("%s returning " #err ": " msg, __func__)
-#define DEBUG_FAIL(msg) do { \
+#define DEBUG_ERROR(err, fmt, ...) DEBUG("%s returning " #err ": " fmt, __func__, ##__VA_ARGS__)
+#define DEBUG_FAIL(fmt, ...) do {               \
        char *errmsg = sp_last_error_message(); \
-       DEBUG("%s returning SP_ERR_FAIL: " msg ": %s", __func__, errmsg); \
+       DEBUG("%s returning SP_ERR_FAIL: "fmt": %s", __func__,##__VA_ARGS__,errmsg); \
        sp_free_error_message(errmsg); \
 } while (0);
 #define RETURN() do { DEBUG("%s returning", __func__); return; } while(0)
@@ -180,8 +184,8 @@ void (*sp_debug_handler)(const char *format, ...) = sp_default_debug_handler;
        } \
 } 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_ERROR(err, ...) do { DEBUG_ERROR(err, __VA_ARGS__); return err; } while (0)
+#define RETURN_FAIL(...) do { DEBUG_FAIL(__VA_ARGS__); return SP_ERR_FAIL; } while (0)
 #define RETURN_VALUE(fmt, x) do { \
        typeof(x) _x = x; \
        DEBUG("%s returning " fmt, __func__, _x); \
@@ -385,7 +389,7 @@ enum sp_return sp_list_ports(struct sp_port ***list_ptr)
                data_len = data_size / sizeof(TCHAR);
                data[data_len] = '\0';
 #ifdef UNICODE
-               name_len = WideCharToMultiByte(CP_ACP, 0, data, -1, NULL, 0, NULL, NULL)
+               name_len = WideCharToMultiByte(CP_ACP, 0, data, -1, NULL, 0, NULL, NULL);
 #else
                name_len = data_len + 1;
 #endif
@@ -622,7 +626,7 @@ enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
        COMSTAT status;
 
        /* Prefix port name with '\\.\' to work with ports above COM9. */
-       if (!(escaped_port_name = malloc(strlen(port->name + 5))))
+       if (!(escaped_port_name = malloc(strlen(port->name) + 5)))
                RETURN_ERROR(SP_ERR_MEM, "Escaped port name malloc failed");
        sprintf(escaped_port_name, "\\\\.\\%s", port->name);
 
@@ -1459,7 +1463,7 @@ enum sp_return sp_wait(struct sp_event_set *event_set, unsigned int timeout)
 #endif
 }
 
-#ifdef __linux__
+#ifdef USE_TERMIOS_SPEED
 static enum sp_return get_baudrate(int fd, int *baudrate)
 {
        void *data;
@@ -1512,62 +1516,64 @@ static enum sp_return set_baudrate(int fd, int baudrate)
 
        RETURN_OK();
 }
+#endif /* USE_TERMIOS_SPEED */
 
 #ifdef USE_TERMIOX
-static enum sp_return get_flow(int fd, int *flow)
+static enum sp_return get_flow(int fd, struct port_data *data)
 {
-       void *data;
+       void *termx;
 
-       TRACE("%d, %p", fd, flow);
+       TRACE("%d, %p", fd, data);
 
        DEBUG("Getting advanced flow control");
 
-       if (!(data = malloc(get_termiox_size())))
+       if (!(termx = malloc(get_termiox_size())))
                RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
 
-       if (ioctl(fd, TCGETX, data) < 0) {
-               free(data);
+       if (ioctl(fd, TCGETX, termx) < 0) {
+               free(termx);
                RETURN_FAIL("getting termiox failed");
        }
 
-       *flow = get_termiox_flow(data);
+       get_termiox_flow(termx, &data->rts_flow, &data->cts_flow,
+                       &data->dtr_flow, &data->dsr_flow);
 
-       free(data);
+       free(termx);
 
        RETURN_OK();
 }
 
-static enum sp_return set_flow(int fd, int flow)
+static enum sp_return set_flow(int fd, struct port_data *data)
 {
-       void *data;
+       void *termx;
 
-       TRACE("%d, %d", fd, flow);
+       TRACE("%d, %p", fd, data);
 
        DEBUG("Getting advanced flow control");
 
-       if (!(data = malloc(get_termiox_size())))
+       if (!(termx = malloc(get_termiox_size())))
                RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
 
-       if (ioctl(fd, TCGETX, data) < 0) {
-               free(data);
+       if (ioctl(fd, TCGETX, termx) < 0) {
+               free(termx);
                RETURN_FAIL("getting termiox failed");
        }
 
        DEBUG("Setting advanced flow control");
 
-       set_termiox_flow(data, flow);
+       set_termiox_flow(termx, data->rts_flow, data->cts_flow,
+                       data->dtr_flow, data->dsr_flow);
 
-       if (ioctl(fd, TCSETX, data) < 0) {
-               free(data);
+       if (ioctl(fd, TCSETX, termx) < 0) {
+               free(termx);
                RETURN_FAIL("setting termiox failed");
        }
 
-       free(data);
+       free(termx);
 
        RETURN_OK();
 }
 #endif /* USE_TERMIOX */
-#endif /* __linux__ */
 
 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
        struct sp_port_config *config)
@@ -1682,7 +1688,7 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data,
                RETURN_FAIL("TIOCMGET ioctl failed");
 
 #ifdef USE_TERMIOX
-       int ret = get_flow(port->fd, &data->flow);
+       int ret = get_flow(port->fd, data);
 
        if (ret == SP_ERR_FAIL && errno == EINVAL)
                data->termiox_supported = 0;
@@ -1704,7 +1710,7 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data,
        if (i == NUM_STD_BAUDRATES) {
 #ifdef __APPLE__
                config->baudrate = (int)data->term.c_ispeed;
-#elif defined(__linux__)
+#elif defined(USE_TERMIOS_SPEED)
                TRY(get_baudrate(port->fd, &config->baudrate));
 #else
                config->baudrate = -1;
@@ -1745,21 +1751,21 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data,
                config->rts = SP_RTS_FLOW_CONTROL;
                config->cts = SP_CTS_FLOW_CONTROL;
        } else {
-               if (data->termiox_supported && data->flow & RTS_FLOW)
+               if (data->termiox_supported && data->rts_flow)
                        config->rts = SP_RTS_FLOW_CONTROL;
                else
                        config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
 
-               config->cts = (data->termiox_supported && data->flow & CTS_FLOW) ?
+               config->cts = (data->termiox_supported && data->cts_flow) ?
                        SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
        }
 
-       if (data->termiox_supported && data->flow & DTR_FLOW)
+       if (data->termiox_supported && data->dtr_flow)
                config->dtr = SP_DTR_FLOW_CONTROL;
        else
                config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
 
-       config->dsr = (data->termiox_supported && data->flow & DSR_FLOW) ?
+       config->dsr = (data->termiox_supported && data->dsr_flow) ?
                SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
 
        if (data->term.c_iflag & IXOFF) {
@@ -1787,7 +1793,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data,
 
        baud_nonstd = B0;
 #endif
-#ifdef __linux__
+#ifdef USE_TERMIOS_SPEED
        int baud_nonstd = 0;
 #endif
 
@@ -1954,7 +1960,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data,
                        if (cfsetspeed(&data->term, B9600) < 0)
                                RETURN_FAIL("cfsetspeed() failed");
                        baud_nonstd = config->baudrate;
-#elif defined(__linux__)
+#elif defined(USE_TERMIOS_SPEED)
                        baud_nonstd = 1;
 #else
                        RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported");
@@ -2033,7 +2039,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data,
 
        if (config->rts >= 0 || config->cts >= 0) {
                if (data->termiox_supported) {
-                       data->flow &= ~(RTS_FLOW | CTS_FLOW);
+                       data->rts_flow = data->cts_flow = 0;
                        switch (config->rts) {
                        case SP_RTS_OFF:
                        case SP_RTS_ON:
@@ -2042,15 +2048,15 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data,
                                        RETURN_FAIL("Setting RTS signal level failed");
                                break;
                        case SP_RTS_FLOW_CONTROL:
-                               data->flow |= RTS_FLOW;
+                               data->rts_flow = 1;
                                break;
                        default:
                                break;
                        }
                        if (config->cts == SP_CTS_FLOW_CONTROL)
-                               data->flow |= CTS_FLOW;
+                               data->cts_flow = 1;
 
-                       if (data->flow & (RTS_FLOW | CTS_FLOW))
+                       if (data->rts_flow && data->cts_flow)
                                data->term.c_iflag |= CRTSCTS;
                        else
                                data->term.c_iflag &= ~CRTSCTS;
@@ -2088,7 +2094,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data,
 
        if (config->dtr >= 0 || config->dsr >= 0) {
                if (data->termiox_supported) {
-                       data->flow &= ~(DTR_FLOW | DSR_FLOW);
+                       data->dtr_flow = data->dsr_flow = 0;
                        switch (config->dtr) {
                        case SP_DTR_OFF:
                        case SP_DTR_ON:
@@ -2097,13 +2103,13 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data,
                                        RETURN_FAIL("Setting DTR signal level failed");
                                break;
                        case SP_DTR_FLOW_CONTROL:
-                               data->flow |= DTR_FLOW;
+                               data->dtr_flow = 1;
                                break;
                        default:
                                break;
                        }
                        if (config->dsr == SP_DSR_FLOW_CONTROL)
-                               data->flow |= DSR_FLOW;
+                               data->dsr_flow = 1;
                } else {
                        /* DTR/DSR flow control not supported. */
                        if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
@@ -2150,11 +2156,13 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data,
                        RETURN_FAIL("cfsetspeed() failed");
        }
 #elif defined(__linux__)
+#ifdef USE_TERMIOS_SPEED
        if (baud_nonstd)
                TRY(set_baudrate(port->fd, config->baudrate));
+#endif
 #ifdef USE_TERMIOX
        if (data->termiox_supported)
-               TRY(set_flow(port->fd, data->flow));
+               TRY(set_flow(port->fd, data));
 #endif
 #endif
 
@@ -2463,3 +2471,45 @@ void sp_default_debug_handler(const char *format, ...)
        }
        va_end(args);
 }
+
+int sp_get_major_package_version(void)
+{
+       return SP_PACKAGE_VERSION_MAJOR;
+}
+
+int sp_get_minor_package_version(void)
+{
+       return SP_PACKAGE_VERSION_MINOR;
+}
+
+int sp_get_micro_package_version(void)
+{
+       return SP_PACKAGE_VERSION_MICRO;
+}
+
+const char *sp_get_package_version_string(void)
+{
+       return SP_PACKAGE_VERSION_STRING;
+}
+
+int sp_get_current_lib_version(void)
+{
+       return SP_LIB_VERSION_CURRENT;
+}
+
+int sp_get_revision_lib_version(void)
+{
+       return SP_LIB_VERSION_REVISION;
+}
+
+int sp_get_age_lib_version(void)
+{
+       return SP_LIB_VERSION_AGE;
+}
+
+const char *sp_get_lib_version_string(void)
+{
+       return SP_LIB_VERSION_STRING;
+}
+
+/** @} */