X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=serialport.c;h=7ab8258511aed5fdb801ac8539f0b451cd73ec58;hb=bccc7c9fa0f00b762392438bea16d4672a984526;hp=fb2e973e60cb146bfba21b55df66c5c58c5a60ff;hpb=71c8a9b906198155c2f494c4eef33b36577a1c2f;p=libserialport.git diff --git a/serialport.c b/serialport.c index fb2e973..7ab8258 100644 --- a/serialport.c +++ b/serialport.c @@ -27,6 +27,8 @@ #include #include #include +#include +#include #ifdef _WIN32 #include #include @@ -56,6 +58,31 @@ #include "libserialport.h" +struct sp_port { + char *name; + int nonblocking; +#ifdef _WIN32 + HANDLE hdl; + OVERLAPPED write_ovl; + BYTE pending_byte; + BOOL writing; +#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; @@ -101,13 +128,41 @@ const struct std_baudrate std_baudrates[] = { #endif }; +void (*sp_debug_handler)(const char *format, ...) = sp_default_debug_handler; + #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0])) #define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates) -#define TRY(x) do { int ret = x; if (ret != SP_OK) return ret; } while (0) +/* 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 { \ + char *errmsg = sp_last_error_message(); \ + DEBUG("%s returning SP_ERR_FAIL: " msg ": %s", __func__, errmsg); \ + sp_free_error_message(errmsg); \ +} while (0); +#define RETURN() do { DEBUG("%s returning", __func__); return; } while(0) +#define RETURN_CODE(x) do { DEBUG("%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); \ + } \ +} 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_VALUE(fmt, x) do { DEBUG("%s returning " fmt, __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("%s(" fmt ") called", __func__, ##__VA_ARGS__) + +#define TRY(x) do { int ret = x; if (ret != SP_OK) RETURN_CODEVAL(ret); } while (0) /* Helper functions. */ -static enum sp_return validate_port(struct sp_port *port); static struct sp_port **list_append(struct sp_port **list, const char *portname); static enum sp_return get_config(struct sp_port *port, struct port_data *data, struct sp_port_config *config); @@ -119,22 +174,26 @@ enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_p struct sp_port *port; int len; + TRACE("%s, %p", portname, port_ptr); + if (!port_ptr) - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); *port_ptr = NULL; if (!portname) - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Null port name"); + + DEBUG("Building structure for port %s", portname); if (!(port = malloc(sizeof(struct sp_port)))) - return SP_ERR_MEM; + RETURN_ERROR(SP_ERR_MEM, "Port structure malloc failed"); len = strlen(portname) + 1; if (!(port->name = malloc(len))) { free(port); - return SP_ERR_MEM; + RETURN_ERROR(SP_ERR_MEM, "Port name malloc failed"); } memcpy(port->name, portname, len); @@ -147,31 +206,75 @@ enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_p *port_ptr = port; - return SP_OK; + RETURN_OK(); +} + +char *sp_get_port_name(const struct sp_port *port) +{ + TRACE("%p", port); + + if (!port) + return NULL; + + RETURN_VALUE("%s", port->name); +} + +enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr) +{ + TRACE("%p", port); + + if (!port) + RETURN_ERROR(SP_ERR_ARG, "Null port"); + +#ifdef _WIN32 + HANDLE *handle_ptr = result_ptr; + *handle_ptr = port->hdl; +#else + int *fd_ptr = result_ptr; + *fd_ptr = port->fd; +#endif + + RETURN_OK(); } enum sp_return sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr) { + TRACE("%p, %p", port, copy_ptr); + if (!copy_ptr) - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); *copy_ptr = NULL; - if (!port || !port->name) - return SP_ERR_ARG; + if (!port) + RETURN_ERROR(SP_ERR_ARG, "Null port"); + + if (!port->name) + RETURN_ERROR(SP_ERR_ARG, "Null port name"); + + DEBUG("Copying port structure"); - return sp_get_port_by_name(port->name, copy_ptr); + RETURN_VALUE("%p", sp_get_port_by_name(port->name, copy_ptr)); } void sp_free_port(struct sp_port *port) { + TRACE("%p", port); + if (!port) - return; + { + DEBUG("Null port"); + RETURN(); + } + + DEBUG("Freeing port structure"); if (port->name) free(port->name); free(port); + + RETURN(); } static struct sp_port **list_append(struct sp_port **list, const char *portname) @@ -196,10 +299,17 @@ fail: enum sp_return sp_list_ports(struct sp_port ***list_ptr) { struct sp_port **list; - int ret = SP_OK; + int ret = SP_ERR_SUPP; + + TRACE("%p", list_ptr); + + if (!list_ptr) + RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); + + DEBUG("Enumerating ports"); if (!(list = malloc(sizeof(struct sp_port **)))) - return SP_ERR_MEM; + RETURN_ERROR(SP_ERR_MEM, "Port list malloc failed"); list[0] = NULL; @@ -212,25 +322,30 @@ enum sp_return sp_list_ports(struct sp_port ***list_ptr) char *name; int name_len; + ret = SP_OK; + + DEBUG("Opening registry key"); if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T("HARDWARE\\DEVICEMAP\\SERIALCOMM"), 0, KEY_QUERY_VALUE, &key) != ERROR_SUCCESS) { - ret = SP_ERR_FAIL; + SET_FAIL(ret, "RegOpenKeyEx() failed"); goto out_done; } + DEBUG("Querying registry key value and data sizes"); if (RegQueryInfoKey(key, NULL, NULL, NULL, NULL, NULL, NULL, NULL, &max_value_len, &max_data_size, NULL, NULL) != ERROR_SUCCESS) { - ret = SP_ERR_FAIL; + SET_FAIL(ret, "RegQueryInfoKey() failed"); goto out_close; } max_data_len = max_data_size / sizeof(TCHAR); if (!(value = malloc((max_value_len + 1) * sizeof(TCHAR)))) { - ret = SP_ERR_MEM; + SET_ERROR(ret, SP_ERR_MEM, "registry value malloc failed"); goto out_close; } if (!(data = malloc((max_data_len + 1) * sizeof(TCHAR)))) { - ret = SP_ERR_MEM; + SET_ERROR(ret, SP_ERR_MEM, "registry data malloc failed"); goto out_free_value; } + DEBUG("Iterating over values"); while ( value_len = max_value_len + 1, data_size = max_data_size, @@ -245,7 +360,7 @@ enum sp_return sp_list_ports(struct sp_port ***list_ptr) name_len = data_len + 1; #endif if (!(name = malloc(name_len))) { - ret = SP_ERR_MEM; + SET_ERROR(ret, SP_ERR_MEM, "registry port name malloc failed"); goto out; } #ifdef UNICODE @@ -253,9 +368,12 @@ enum sp_return sp_list_ports(struct sp_port ***list_ptr) #else strcpy(name, data); #endif - if (type == REG_SZ && !(list = list_append(list, name))) { - ret = SP_ERR_MEM; - goto out; + if (type == REG_SZ) { + DEBUG("Found port %s", name); + if (!(list = list_append(list, name))) { + SET_ERROR(ret, SP_ERR_MEM, "list append failed"); + goto out; + } } index++; } @@ -276,29 +394,35 @@ out_done: CFTypeRef cf_path; Boolean result; + ret = SP_OK; + + DEBUG("Getting IOKit master port"); if (IOMasterPort(MACH_PORT_NULL, &master) != KERN_SUCCESS) { - ret = SP_ERR_FAIL; + SET_FAIL(ret, "IOMasterPort() failed"); goto out_done; } + DEBUG("Creating matching dictionary"); if (!(classes = IOServiceMatching(kIOSerialBSDServiceValue))) { - ret = SP_ERR_FAIL; + SET_FAIL(ret, "IOServiceMatching() failed"); goto out_done; } CFDictionarySetValue(classes, CFSTR(kIOSerialBSDTypeKey), CFSTR(kIOSerialBSDAllTypes)); + DEBUG("Getting matching services"); if (IOServiceGetMatchingServices(master, classes, &iter) != KERN_SUCCESS) { - ret = SP_ERR_FAIL; + SET_FAIL(ret, "IOServiceGetMatchingServices() failed"); goto out_done; } if (!(path = malloc(PATH_MAX))) { - ret = SP_ERR_MEM; + SET_ERROR(ret, SP_ERR_MEM, "device path malloc failed"); goto out_release; } + DEBUG("Iterating over results"); while ((port = IOIteratorNext(iter))) { cf_path = IORegistryEntryCreateCFProperty(port, CFSTR(kIOCalloutDeviceKey), kCFAllocatorDefault, 0); @@ -306,10 +430,13 @@ out_done: result = CFStringGetCString(cf_path, path, PATH_MAX, kCFStringEncodingASCII); CFRelease(cf_path); - if (result && !(list = list_append(list, path))) { - ret = SP_ERR_MEM; - IOObjectRelease(port); - goto out; + if (result) { + DEBUG("Found port %s", path); + if (!(list = list_append(list, path))) { + SET_ERROR(ret, SP_ERR_MEM, "list append failed"); + IOObjectRelease(port); + goto out; + } } } IOObjectRelease(port); @@ -332,17 +459,23 @@ out_done: int fd, ioctl_result; struct serial_struct serial_info; + ret = SP_OK; + + DEBUG("Enumerating tty devices"); ud = udev_new(); ud_enumerate = udev_enumerate_new(ud); udev_enumerate_add_match_subsystem(ud_enumerate, "tty"); udev_enumerate_scan_devices(ud_enumerate); ud_list = udev_enumerate_get_list_entry(ud_enumerate); + DEBUG("Iterating over results"); udev_list_entry_foreach(ud_entry, ud_list) { path = udev_list_entry_get_name(ud_entry); + DEBUG("Found device %s", path); ud_dev = udev_device_new_from_syspath(ud, path); /* If there is no parent device, this is a virtual tty. */ ud_parent = udev_device_get_parent(ud_dev); if (ud_parent == NULL) { + DEBUG("No parent device, assuming virtual tty"); udev_device_unref(ud_dev); continue; } @@ -352,20 +485,28 @@ out_done: * is to try to open them and make an ioctl call. */ driver = udev_device_get_driver(ud_parent); if (driver && !strcmp(driver, "serial8250")) { - if ((fd = open(name, O_RDWR | O_NONBLOCK | O_NOCTTY)) < 0) + DEBUG("serial8250 device, attempting to open"); + if ((fd = open(name, O_RDWR | O_NONBLOCK | O_NOCTTY)) < 0) { + DEBUG("open failed, skipping"); goto skip; + } ioctl_result = ioctl(fd, TIOCGSERIAL, &serial_info); close(fd); - if (ioctl_result != 0) + if (ioctl_result != 0) { + DEBUG("ioctl failed, skipping"); goto skip; - if (serial_info.type == PORT_UNKNOWN) + } + if (serial_info.type == PORT_UNKNOWN) { + DEBUG("port type is unknown, skipping"); goto skip; + } } + DEBUG("Found port %s", name); list = list_append(list, name); skip: udev_device_unref(ud_dev); if (!list) { - ret = SP_ERR_MEM; + SET_ERROR(ret, SP_ERR_MEM, "list append failed"); goto out; } } @@ -374,54 +515,87 @@ out: udev_unref(ud); #endif - if (ret == SP_OK) { + switch (ret) { + case SP_OK: *list_ptr = list; - } else { + RETURN_OK(); + case SP_ERR_SUPP: + DEBUG_ERROR(SP_ERR_SUPP, "Enumeration not supported on this platform."); + default: if (list) sp_free_port_list(list); *list_ptr = NULL; + return ret; } - - return ret; } void sp_free_port_list(struct sp_port **list) { unsigned int i; + TRACE("%p", list); + + if (!list) { + DEBUG("Null list"); + RETURN(); + } + + DEBUG("Freeing port list"); + for (i = 0; list[i]; i++) sp_free_port(list[i]); free(list); + + RETURN(); } -static enum sp_return validate_port(struct sp_port *port) -{ - if (port == NULL) - return 0; +#define CHECK_PORT() do { \ + if (port == NULL) \ + RETURN_ERROR(SP_ERR_ARG, "Null port"); \ + if (port->name == NULL) \ + RETURN_ERROR(SP_ERR_ARG, "Null port name"); \ +} while (0) #ifdef _WIN32 - if (port->hdl == INVALID_HANDLE_VALUE) - return 0; +#define CHECK_PORT_HANDLE() do { \ + if (port->hdl == INVALID_HANDLE_VALUE) \ + RETURN_ERROR(SP_ERR_ARG, "Invalid port handle"); \ +} while (0) #else - if (port->fd < 0) - return 0; +#define CHECK_PORT_HANDLE() do { \ + if (port->fd < 0) \ + RETURN_ERROR(SP_ERR_ARG, "Invalid port fd"); \ +} while (0) #endif - return 1; -} - -#define CHECK_PORT() do { if (!validate_port(port)) return SP_ERR_ARG; } while (0) +#define CHECK_OPEN_PORT() do { \ + CHECK_PORT(); \ + CHECK_PORT_HANDLE(); \ +} while (0) enum sp_return sp_open(struct sp_port *port, enum sp_mode flags) { - if (!port) - return SP_ERR_ARG; + struct port_data data; + struct sp_port_config config; + enum sp_return ret; + + TRACE("%p, %x", port, flags); + + CHECK_PORT(); + + if (flags > (SP_MODE_READ | SP_MODE_WRITE | SP_MODE_NONBLOCK)) + RETURN_ERROR(SP_ERR_ARG, "Invalid flags"); + + DEBUG("Opening port %s", port->name); + + port->nonblocking = (flags & SP_MODE_NONBLOCK) ? 1 : 0; #ifdef _WIN32 DWORD desired_access = 0, flags_and_attributes = 0; + COMMTIMEOUTS timeouts; char *escaped_port_name; /* Prefix port name with '\\.\' to work with ports above COM9. */ if (!(escaped_port_name = malloc(strlen(port->name + 5)))) - return SP_ERR_MEM; + RETURN_ERROR(SP_ERR_MEM, "Escaped port name malloc failed"); sprintf(escaped_port_name, "\\\\.\\%s", port->name); /* Map 'flags' to the OS-specific settings. */ @@ -439,12 +613,33 @@ enum sp_return sp_open(struct sp_port *port, enum sp_mode flags) free(escaped_port_name); if (port->hdl == INVALID_HANDLE_VALUE) - return SP_ERR_FAIL; + RETURN_FAIL("CreateFile() failed"); + + /* All timeouts disabled. */ + timeouts.ReadIntervalTimeout = 0; + timeouts.ReadTotalTimeoutMultiplier = 0; + timeouts.ReadTotalTimeoutConstant = 0; + timeouts.WriteTotalTimeoutMultiplier = 0; + timeouts.WriteTotalTimeoutConstant = 0; + + if (port->nonblocking) { + /* Set read timeout such that all reads return immediately. */ + timeouts.ReadIntervalTimeout = MAXDWORD; + /* Prepare OVERLAPPED structure for non-blocking writes. */ + memset(&port->write_ovl, 0, sizeof(port->write_ovl)); + if (!(port->write_ovl.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL))) { + sp_close(port); + RETURN_FAIL("CreateEvent() failed"); + } + port->writing = FALSE; + } + + if (SetCommTimeouts(port->hdl, &timeouts) == 0) { + sp_close(port); + RETURN_FAIL("SetCommTimeouts() failed"); + } #else int flags_local = 0; - struct port_data data; - struct sp_port_config config; - int ret; /* Map 'flags' to the OS-specific settings. */ if (flags & (SP_MODE_READ | SP_MODE_WRITE)) @@ -457,60 +652,88 @@ enum sp_return sp_open(struct sp_port *port, enum sp_mode flags) flags_local |= O_NONBLOCK; if ((port->fd = open(port->name, flags_local)) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("open() failed"); +#endif ret = get_config(port, &data, &config); if (ret < 0) { sp_close(port); - return ret; + RETURN_CODEVAL(ret); } - /* Turn off all serial port cooking. */ - data.term.c_iflag &= ~(ISTRIP | INLCR | ICRNL); - data.term.c_oflag &= ~(ONLCR | OCRNL | ONOCR); -#if !defined(__FreeBSD__) && !defined(__OpenBSD__) && !defined(__NetBSD__) + /* Set sane port settings. */ +#ifdef _WIN32 + data.dcb.fBinary = TRUE; + data.dcb.fDsrSensitivity = FALSE; + data.dcb.fErrorChar = FALSE; + data.dcb.fNull = FALSE; + data.dcb.fAbortOnError = TRUE; +#else + /* Turn off all fancy termios tricks, give us a raw channel. */ + data.term.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP|INLCR|IGNCR|ICRNL|IUCLC|IMAXBEL); + data.term.c_oflag &= ~(OPOST|OLCUC|ONLCR|OCRNL|ONOCR|ONLRET|NLDLY|CRDLY|TABDLY|BSDLY|VTDLY|FFDLY); +#ifdef OFILL data.term.c_oflag &= ~OFILL; #endif - /* Disable canonical mode, and don't echo input characters. */ - data.term.c_lflag &= ~(ICANON | ECHO); + data.term.c_lflag &= ~(ISIG|ICANON|ECHO|IEXTEN); + data.term.c_cc[VMIN] = 0; + data.term.c_cc[VTIME] = 0; - /* Ignore modem status lines; enable receiver */ - data.term.c_cflag |= (CLOCAL | CREAD); + /* Ignore modem status lines; enable receiver; leave control lines alone on close. */ + data.term.c_cflag |= (CLOCAL | CREAD | HUPCL); +#endif ret = set_config(port, &data, &config); if (ret < 0) { sp_close(port); - return ret; + RETURN_CODEVAL(ret); } -#endif - return SP_OK; + RETURN_OK(); } enum sp_return sp_close(struct sp_port *port) { - CHECK_PORT(); + TRACE("%p", port); + + CHECK_OPEN_PORT(); + + DEBUG("Closing port %s", port->name); #ifdef _WIN32 /* Returns non-zero upon success, 0 upon failure. */ if (CloseHandle(port->hdl) == 0) - return SP_ERR_FAIL; + RETURN_FAIL("CloseHandle() failed"); port->hdl = INVALID_HANDLE_VALUE; + if (port->nonblocking) { + /* Close event handle created for overlapped writes. */ + if (CloseHandle(port->write_ovl.hEvent) == 0) + RETURN_FAIL("CloseHandle() failed"); + } #else /* Returns 0 upon success, -1 upon failure. */ if (close(port->fd) == -1) - return SP_ERR_FAIL; + RETURN_FAIL("close() failed"); port->fd = -1; #endif - return SP_OK; + RETURN_OK(); } enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers) { - CHECK_PORT(); + TRACE("%p, %x", port, buffers); + + CHECK_OPEN_PORT(); + + if (buffers > SP_BUF_BOTH) + RETURN_ERROR(SP_ERR_ARG, "Invalid buffer selection"); + + const char *buffer_names[] = {"no", "input", "output", "both"}; + + DEBUG("Flushing %s buffers on port %s", buffer_names[buffers], port->name); #ifdef _WIN32 DWORD flags = 0; @@ -521,7 +744,7 @@ enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers) /* Returns non-zero upon success, 0 upon failure. */ if (PurgeComm(port->hdl, flags) == 0) - return SP_ERR_FAIL; + RETURN_FAIL("PurgeComm() failed"); #else int flags = 0; if (buffers & SP_BUF_BOTH) @@ -533,74 +756,140 @@ enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers) /* Returns 0 upon success, -1 upon failure. */ if (tcflush(port->fd, flags) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("tcflush() failed"); #endif - return SP_OK; + RETURN_OK(); } enum sp_return sp_drain(struct sp_port *port) { - CHECK_PORT(); + TRACE("%p", port); + + CHECK_OPEN_PORT(); + + DEBUG("Draining port %s", port->name); #ifdef _WIN32 /* Returns non-zero upon success, 0 upon failure. */ if (FlushFileBuffers(port->hdl) == 0) - return SP_ERR_FAIL; + RETURN_FAIL("FlushFileBuffers() failed"); #else /* Returns 0 upon success, -1 upon failure. */ if (tcdrain(port->fd) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("tcdrain() failed"); #endif - return SP_OK; + RETURN_OK(); } enum sp_return sp_write(struct sp_port *port, const void *buf, size_t count) { - CHECK_PORT(); + TRACE("%p, %p, %d", port, buf, count); + + CHECK_OPEN_PORT(); if (!buf) - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Null buffer"); + + DEBUG("Writing up to %d bytes to port %s", count, port->name); + + if (count == 0) + RETURN_VALUE("0", 0); #ifdef _WIN32 DWORD written = 0; + BYTE *ptr = (BYTE *) buf; - /* Returns non-zero upon success, 0 upon failure. */ - if (WriteFile(port->hdl, buf, count, &written, NULL) == 0) - return SP_ERR_FAIL; - return written; + if (port->nonblocking) { + /* Non-blocking write. */ + + /* Check whether previous write is complete. */ + if (port->writing) { + if (HasOverlappedIoCompleted(&port->write_ovl)) { + DEBUG("Previous write completed"); + port->writing = 0; + } else { + DEBUG("Previous write not complete"); + /* Can't take a new write until the previous one finishes. */ + RETURN_VALUE("0", 0); + } + } + + /* Keep writing data until the OS has to actually start an async IO for it. + * At that point we know the buffer is full. */ + while (written < count) + { + /* Copy first byte of user buffer. */ + port->pending_byte = *ptr++; + + /* Start asynchronous write. */ + if (WriteFile(port->hdl, &port->pending_byte, 1, NULL, &port->write_ovl) == 0) { + if (GetLastError() == ERROR_IO_PENDING) { + DEBUG("Asynchronous write started"); + port->writing = 1; + RETURN_VALUE("%d", ++written); + } else { + /* Actual failure of some kind. */ + RETURN_FAIL("WriteFile() failed"); + } + } else { + DEBUG("Single byte written immediately."); + written++; + } + } + + DEBUG("All bytes written immediately."); + + } else { + /* Blocking write. */ + if (WriteFile(port->hdl, buf, count, &written, NULL) == 0) { + RETURN_FAIL("WriteFile() failed"); + } + } + + RETURN_VALUE("%d", written); #else /* Returns the number of bytes written, or -1 upon failure. */ ssize_t written = write(port->fd, buf, count); if (written < 0) - return SP_ERR_FAIL; + RETURN_FAIL("write() failed"); else - return written; + RETURN_VALUE("%d", written); #endif } enum sp_return sp_read(struct sp_port *port, void *buf, size_t count) { - CHECK_PORT(); + TRACE("%p, %p, %d", port, buf, count); + + CHECK_OPEN_PORT(); if (!buf) - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Null buffer"); + + DEBUG("Reading up to %d bytes from port %s", count, port->name); #ifdef _WIN32 DWORD bytes_read = 0; /* Returns non-zero upon success, 0 upon failure. */ if (ReadFile(port->hdl, buf, count, &bytes_read, NULL) == 0) - return SP_ERR_FAIL; - return bytes_read; + RETURN_FAIL("ReadFile() failed"); + RETURN_VALUE("%d", bytes_read); #else ssize_t bytes_read; /* Returns the number of bytes read, or -1 upon failure. */ - if ((bytes_read = read(port->fd, buf, count)) < 0) - return SP_ERR_FAIL; - return bytes_read; + if ((bytes_read = read(port->fd, buf, count)) < 0) { + if (port->nonblocking && errno == EAGAIN) + /* Port is opened in nonblocking mode and there are no bytes available. */ + bytes_read = 0; + else + /* This is an actual failure. */ + RETURN_FAIL("read() failed"); + } + RETURN_VALUE("%d", bytes_read); #endif } @@ -609,43 +898,53 @@ static enum sp_return get_baudrate(int fd, int *baudrate) { void *data; + TRACE("%d, %p", fd, baudrate); + + DEBUG("Getting baud rate"); + if (!(data = malloc(get_termios_size()))) - return SP_ERR_MEM; + RETURN_ERROR(SP_ERR_MEM, "termios malloc failed"); if (ioctl(fd, get_termios_get_ioctl(), data) < 0) { free(data); - return SP_ERR_FAIL; + RETURN_FAIL("getting termios failed"); } *baudrate = get_termios_speed(data); free(data); - return SP_OK; + RETURN_OK(); } static enum sp_return set_baudrate(int fd, int baudrate) { void *data; + TRACE("%d, %d", fd, baudrate); + + DEBUG("Getting baud rate"); + if (!(data = malloc(get_termios_size()))) - return SP_ERR_MEM; + RETURN_ERROR(SP_ERR_MEM, "termios malloc failed"); if (ioctl(fd, get_termios_get_ioctl(), data) < 0) { free(data); - return SP_ERR_FAIL; + RETURN_FAIL("getting termios failed"); } + DEBUG("Setting baud rate"); + set_termios_speed(data, baudrate); if (ioctl(fd, get_termios_set_ioctl(), data) < 0) { free(data); - return SP_ERR_FAIL; + RETURN_FAIL("setting termios failed"); } free(data); - return SP_OK; + RETURN_OK(); } #ifdef USE_TERMIOX @@ -653,43 +952,53 @@ static enum sp_return get_flow(int fd, int *flow) { void *data; + TRACE("%d, %p", fd, flow); + + DEBUG("Getting advanced flow control"); + if (!(data = malloc(get_termiox_size()))) - return SP_ERR_MEM; + RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed"); if (ioctl(fd, TCGETX, data) < 0) { free(data); - return SP_ERR_FAIL; + RETURN_FAIL("getting termiox failed"); } *flow = get_termiox_flow(data); free(data); - return SP_OK; + RETURN_OK(); } static enum sp_return set_flow(int fd, int flow) { void *data; + TRACE("%d, %d", fd, flow); + + DEBUG("Getting advanced flow control"); + if (!(data = malloc(get_termiox_size()))) - return SP_ERR_MEM; + RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed"); if (ioctl(fd, TCGETX, data) < 0) { free(data); - return SP_ERR_FAIL; + RETURN_FAIL("getting termiox failed"); } + DEBUG("Setting advanced flow control"); + set_termiox_flow(data, flow); if (ioctl(fd, TCSETX, data) < 0) { free(data); - return SP_ERR_FAIL; + RETURN_FAIL("setting termiox failed"); } free(data); - return SP_OK; + RETURN_OK(); } #endif /* USE_TERMIOX */ #endif /* __linux__ */ @@ -699,9 +1008,13 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data, { unsigned int i; + TRACE("%p, %p, %p", port, data, config); + + DEBUG("Getting configuration for port %s", port->name); + #ifdef _WIN32 if (!GetCommState(port->hdl, &data->dcb)) - return SP_ERR_FAIL; + RETURN_FAIL("GetCommState() failed"); for (i = 0; i < NUM_STD_BAUDRATES; i++) { if (data->dcb.BaudRate == std_baudrates[i].index) { @@ -721,11 +1034,17 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data, case NOPARITY: config->parity = SP_PARITY_NONE; break; + case ODDPARITY: + config->parity = SP_PARITY_ODD; + break; case EVENPARITY: config->parity = SP_PARITY_EVEN; break; - case ODDPARITY: - config->parity = SP_PARITY_ODD; + case MARKPARITY: + config->parity = SP_PARITY_MARK; + break; + case SPACEPARITY: + config->parity = SP_PARITY_SPACE; break; default: config->parity = -1; @@ -791,10 +1110,10 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data, #else // !_WIN32 if (tcgetattr(port->fd, &data->term) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("tcgetattr() failed"); if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("TIOCMGET ioctl failed"); #ifdef USE_TERMIOX int ret = get_flow(port->fd, &data->flow); @@ -802,7 +1121,7 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data, if (ret == SP_ERR_FAIL && errno == EINVAL) data->termiox_supported = 0; else if (ret < 0) - return ret; + RETURN_CODEVAL(ret); else data->termiox_supported = 1; #else @@ -847,6 +1166,8 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data, config->parity = SP_PARITY_NONE; else if (!(data->term.c_cflag & PARENB) || (data->term.c_iflag & IGNPAR)) config->parity = -1; + else if (data->term.c_cflag & CMSPAR) + config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_MARK : SP_PARITY_SPACE; else config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_ODD : SP_PARITY_EVEN; @@ -886,7 +1207,7 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data, } #endif - return SP_OK; + RETURN_OK(); } static enum sp_return set_config(struct sp_port *port, struct port_data *data, @@ -902,6 +1223,10 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, int baud_nonstd = 0; #endif + TRACE("%p, %p, %p", port, data, config); + + DEBUG("Setting configuration for port %s", port->name); + #ifdef _WIN32 if (config->baudrate >= 0) { for (i = 0; i < NUM_STD_BAUDRATES; i++) { @@ -924,14 +1249,20 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, case SP_PARITY_NONE: data->dcb.Parity = NOPARITY; break; + case SP_PARITY_ODD: + data->dcb.Parity = ODDPARITY; + break; case SP_PARITY_EVEN: data->dcb.Parity = EVENPARITY; break; - case SP_PARITY_ODD: - data->dcb.Parity = ODDPARITY; + case SP_PARITY_MARK: + data->dcb.Parity = MARKPARITY; + break; + case SP_PARITY_SPACE: + data->dcb.Parity = SPACEPARITY; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting"); } } @@ -945,7 +1276,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->dcb.StopBits = TWOSTOPBITS; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid stop bit setting"); } } @@ -961,7 +1292,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid RTS setting"); } } @@ -974,7 +1305,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->dcb.fOutxCtsFlow = TRUE; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid CTS setting"); } } @@ -990,7 +1321,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid DTR setting"); } } @@ -1003,7 +1334,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->dcb.fOutxDsrFlow = TRUE; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid DSR setting"); } } @@ -1026,12 +1357,12 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->dcb.fOutX = TRUE; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting"); } } if (!SetCommState(port->hdl, &data->dcb)) - return SP_ERR_FAIL; + RETURN_FAIL("SetCommState() failed"); #else /* !_WIN32 */ @@ -1041,10 +1372,10 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, for (i = 0; i < NUM_STD_BAUDRATES; i++) { if (config->baudrate == std_baudrates[i].value) { if (cfsetospeed(&data->term, std_baudrates[i].index) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("cfsetospeed() failed"); if (cfsetispeed(&data->term, std_baudrates[i].index) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("cfsetispeed() failed"); break; } } @@ -1054,12 +1385,12 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, #ifdef __APPLE__ /* Set "dummy" baud rate. */ if (cfsetspeed(&data->term, B9600) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("cfsetspeed() failed"); baud_nonstd = config->baudrate; #elif defined(__linux__) baud_nonstd = 1; #else - return SP_ERR_SUPP; + RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported"); #endif } } @@ -1080,13 +1411,13 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->term.c_cflag |= CS5; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid data bits setting"); } } if (config->parity >= 0) { data->term.c_iflag &= ~IGNPAR; - data->term.c_cflag &= ~(PARENB | PARODD); + data->term.c_cflag &= ~(PARENB | PARODD | CMSPAR); switch (config->parity) { case SP_PARITY_NONE: data->term.c_iflag |= IGNPAR; @@ -1097,8 +1428,14 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, case SP_PARITY_ODD: data->term.c_cflag |= PARENB | PARODD; break; + case SP_PARITY_MARK: + data->term.c_cflag |= PARENB | PARODD | CMSPAR; + break; + case SP_PARITY_SPACE: + data->term.c_cflag |= PARENB | CMSPAR; + break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting"); } } @@ -1112,7 +1449,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->term.c_cflag |= CSTOPB; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid stop bits setting"); } } @@ -1124,7 +1461,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, case SP_RTS_ON: controlbits = TIOCM_RTS; if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("Setting RTS signal level failed"); break; case SP_RTS_FLOW_CONTROL: data->flow |= RTS_FLOW; @@ -1145,17 +1482,17 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, /* Flow control can only be disabled for both RTS & CTS together. */ if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) { if (config->cts != SP_CTS_IGNORE) - return SP_ERR_SUPP; + RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together"); } if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) { if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL) - return SP_ERR_SUPP; + RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together"); } } else { /* Flow control can only be enabled for both RTS & CTS together. */ if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) || ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL))) - return SP_ERR_SUPP; + RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be enabled together"); } if (config->rts >= 0) { @@ -1165,7 +1502,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, controlbits = TIOCM_RTS; if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("Setting RTS signal level failed"); } } } @@ -1179,7 +1516,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, case SP_DTR_ON: controlbits = TIOCM_DTR; if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("Setting DTR signal level failed"); break; case SP_DTR_FLOW_CONTROL: data->flow |= DTR_FLOW; @@ -1192,13 +1529,13 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, } else { /* DTR/DSR flow control not supported. */ if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL) - return SP_ERR_SUPP; + RETURN_ERROR(SP_ERR_SUPP, "DTR/DSR flow control not supported"); if (config->dtr >= 0) { controlbits = TIOCM_DTR; if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("Setting DTR signal level failed"); } } } @@ -1218,21 +1555,21 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->term.c_iflag |= IXON | IXOFF | IXANY; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting"); } } - if (tcsetattr(port->fd, TCSADRAIN, &data->term) < 0) - return SP_ERR_FAIL; + if (tcsetattr(port->fd, TCSANOW, &data->term) < 0) + RETURN_FAIL("tcsetattr() failed"); #ifdef __APPLE__ if (baud_nonstd != B0) { if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1) - return SP_ERR_FAIL; + RETURN_FAIL("IOSSIOSPEED ioctl failed"); /* Set baud rates in data->term to correct, but incompatible * with tcsetattr() value, same as delivered by tcgetattr(). */ if (cfsetspeed(&data->term, baud_nonstd) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("cfsetspeed() failed"); } #elif defined(__linux__) if (baud_nonstd) @@ -1245,7 +1582,62 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, #endif /* !_WIN32 */ - return SP_OK; + RETURN_OK(); +} + +enum sp_return sp_new_config(struct sp_port_config **config_ptr) +{ + TRACE("%p", config_ptr); + struct sp_port_config *config; + + if (!config_ptr) + RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); + + *config_ptr = NULL; + + if (!(config = malloc(sizeof(struct sp_port_config)))) + RETURN_ERROR(SP_ERR_MEM, "config malloc failed"); + + config->baudrate = -1; + config->bits = -1; + config->parity = -1; + config->stopbits = -1; + config->rts = -1; + config->cts = -1; + config->dtr = -1; + config->dsr = -1; + + *config_ptr = config; + + RETURN_OK(); +} + +void sp_free_config(struct sp_port_config *config) +{ + TRACE("%p", config); + + if (!config) + DEBUG("Null config"); + else + free(config); + + RETURN(); +} + +enum sp_return sp_get_config(struct sp_port *port, struct sp_port_config *config) +{ + struct port_data data; + + TRACE("%p, %p", port, config); + + CHECK_OPEN_PORT(); + + if (!config) + RETURN_ERROR(SP_ERR_ARG, "Null config"); + + TRY(get_config(port, &data, config)); + + RETURN_OK(); } enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *config) @@ -1253,98 +1645,135 @@ enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config * struct port_data data; struct sp_port_config prev_config; - CHECK_PORT(); + TRACE("%p, %p", port, config); + + CHECK_OPEN_PORT(); if (!config) - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Null config"); TRY(get_config(port, &data, &prev_config)); TRY(set_config(port, &data, config)); - return SP_OK; + RETURN_OK(); } -#define CREATE_SETTER(x, type) int sp_set_##x(struct sp_port *port, type x) { \ +#define CREATE_ACCESSORS(x, type) \ +enum sp_return sp_set_##x(struct sp_port *port, type x) { \ struct port_data data; \ struct sp_port_config config; \ - CHECK_PORT(); \ + TRACE("%p, %d", port, x); \ + CHECK_OPEN_PORT(); \ TRY(get_config(port, &data, &config)); \ config.x = x; \ TRY(set_config(port, &data, &config)); \ - return SP_OK; \ + RETURN_OK(); \ +} \ +enum sp_return sp_get_config_##x(const struct sp_port_config *config, type *x) { \ + TRACE("%p", config); \ + if (!config) \ + RETURN_ERROR(SP_ERR_ARG, "Null config"); \ + *x = config->x; \ + RETURN_OK(); \ +} \ +enum sp_return sp_set_config_##x(struct sp_port_config *config, type x) { \ + TRACE("%p, %d", config, x); \ + if (!config) \ + RETURN_ERROR(SP_ERR_ARG, "Null config"); \ + config->x = x; \ + RETURN_OK(); \ } -CREATE_SETTER(baudrate, int) -CREATE_SETTER(bits, int) -CREATE_SETTER(parity, enum sp_parity) -CREATE_SETTER(stopbits, int) -CREATE_SETTER(rts, enum sp_rts) -CREATE_SETTER(cts, enum sp_cts) -CREATE_SETTER(dtr, enum sp_dtr) -CREATE_SETTER(dsr, enum sp_dsr) -CREATE_SETTER(xon_xoff, enum sp_xonxoff) - -enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol) +CREATE_ACCESSORS(baudrate, int) +CREATE_ACCESSORS(bits, int) +CREATE_ACCESSORS(parity, enum sp_parity) +CREATE_ACCESSORS(stopbits, int) +CREATE_ACCESSORS(rts, enum sp_rts) +CREATE_ACCESSORS(cts, enum sp_cts) +CREATE_ACCESSORS(dtr, enum sp_dtr) +CREATE_ACCESSORS(dsr, enum sp_dsr) +CREATE_ACCESSORS(xon_xoff, enum sp_xonxoff) + +enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config, enum sp_flowcontrol flowcontrol) { - struct port_data data; - struct sp_port_config config; - - CHECK_PORT(); + if (!config) + RETURN_ERROR(SP_ERR_ARG, "Null configuration"); - TRY(get_config(port, &data, &config)); + if (flowcontrol > SP_FLOWCONTROL_DTRDSR) + RETURN_ERROR(SP_ERR_ARG, "Invalid flow control setting"); if (flowcontrol == SP_FLOWCONTROL_XONXOFF) - config.xon_xoff = SP_XONXOFF_INOUT; + config->xon_xoff = SP_XONXOFF_INOUT; else - config.xon_xoff = SP_XONXOFF_DISABLED; + config->xon_xoff = SP_XONXOFF_DISABLED; if (flowcontrol == SP_FLOWCONTROL_RTSCTS) { - config.rts = SP_RTS_FLOW_CONTROL; - config.cts = SP_CTS_FLOW_CONTROL; + config->rts = SP_RTS_FLOW_CONTROL; + config->cts = SP_CTS_FLOW_CONTROL; } else { - if (config.rts == SP_RTS_FLOW_CONTROL) - config.rts = SP_RTS_ON; - config.cts = SP_CTS_IGNORE; + if (config->rts == SP_RTS_FLOW_CONTROL) + config->rts = SP_RTS_ON; + config->cts = SP_CTS_IGNORE; } if (flowcontrol == SP_FLOWCONTROL_DTRDSR) { - config.dtr = SP_DTR_FLOW_CONTROL; - config.dsr = SP_DSR_FLOW_CONTROL; + config->dtr = SP_DTR_FLOW_CONTROL; + config->dsr = SP_DSR_FLOW_CONTROL; } else { - if (config.dtr == SP_DTR_FLOW_CONTROL) - config.dtr = SP_DTR_ON; - config.dsr = SP_DSR_IGNORE; + if (config->dtr == SP_DTR_FLOW_CONTROL) + config->dtr = SP_DTR_ON; + config->dsr = SP_DSR_IGNORE; } + RETURN_OK(); +} + +enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol) +{ + struct port_data data; + struct sp_port_config config; + + TRACE("%p, %d", port, flowcontrol); + + CHECK_OPEN_PORT(); + + TRY(get_config(port, &data, &config)); + + TRY(sp_set_config_flowcontrol(&config, flowcontrol)); + TRY(set_config(port, &data, &config)); - return SP_OK; + RETURN_OK(); } enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals) { - CHECK_PORT(); + TRACE("%p, %p", port, signals); + + CHECK_OPEN_PORT(); if (!signals) - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); + + DEBUG("Getting control signals for port %s", port->name); *signals = 0; #ifdef _WIN32 DWORD bits; if (GetCommModemStatus(port->hdl, &bits) == 0) - return SP_ERR_FAIL; + RETURN_FAIL("GetCommModemStatus() failed"); if (bits & MS_CTS_ON) *signals |= SP_SIG_CTS; if (bits & MS_DSR_ON) *signals |= SP_SIG_DSR; - if (bits & MS_RING_ON) - *signals |= SP_SIG_DCD; if (bits & MS_RLSD_ON) + *signals |= SP_SIG_DCD; + if (bits & MS_RING_ON) *signals |= SP_SIG_RI; #else int bits; if (ioctl(port->fd, TIOCMGET, &bits) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("TIOCMGET ioctl failed"); if (bits & TIOCM_CTS) *signals |= SP_SIG_CTS; if (bits & TIOCM_DSR) @@ -1354,48 +1783,55 @@ enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals) if (bits & TIOCM_RNG) *signals |= SP_SIG_RI; #endif - return SP_OK; + RETURN_OK(); } enum sp_return sp_start_break(struct sp_port *port) { - CHECK_PORT(); + TRACE("%p", port); + + CHECK_OPEN_PORT(); #ifdef _WIN32 if (SetCommBreak(port->hdl) == 0) - return SP_ERR_FAIL; + RETURN_FAIL("SetCommBreak() failed"); #else if (ioctl(port->fd, TIOCSBRK, 1) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("TIOCSBRK ioctl failed"); #endif - return SP_OK; + RETURN_OK(); } enum sp_return sp_end_break(struct sp_port *port) { - CHECK_PORT(); + TRACE("%p", port); + + CHECK_OPEN_PORT(); #ifdef _WIN32 if (ClearCommBreak(port->hdl) == 0) - return SP_ERR_FAIL; + RETURN_FAIL("ClearCommBreak() failed"); #else if (ioctl(port->fd, TIOCCBRK, 1) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("TIOCCBRK ioctl failed"); #endif - return SP_OK; + RETURN_OK(); } int sp_last_error_code(void) { + TRACE(""); #ifdef _WIN32 - return GetLastError(); + RETURN_VALUE("%d", GetLastError()); #else - return errno; + RETURN_VALUE("%d", errno); #endif } char *sp_last_error_message(void) { + TRACE(""); + #ifdef _WIN32 LPVOID message; DWORD error = GetLastError(); @@ -1410,17 +1846,41 @@ char *sp_last_error_message(void) (LPTSTR) &message, 0, NULL ); - return message; + RETURN_VALUE("%s", message); #else - return strerror(errno); + RETURN_VALUE("%s", strerror(errno)); #endif } void sp_free_error_message(char *message) { + TRACE("%s", message); + #ifdef _WIN32 LocalFree(message); #else (void)message; #endif + + RETURN(); +} + +void sp_set_debug_handler(void (*handler)(const char *format, ...)) +{ + TRACE("%p", handler); + + sp_debug_handler = handler; + + RETURN(); +} + +void sp_default_debug_handler(const char *format, ...) +{ + va_list args; + va_start(args, format); + if (getenv("LIBSERIALPORT_DEBUG")) { + fputs("libserialport: ", stderr); + vfprintf(stderr, format, args); + } + va_end(args); }