X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=serialport.c;h=074534edb8a898c280109a25b3da9ae537e1820e;hb=025c264448de771ceb130d4d01aacbb9ca8453ea;hp=290786a4c1ce92945baac78208033b54b6452e71;hpb=e4ce975a54c60cda6615e4829ae1408adaec8fcf;p=libserialport.git diff --git a/serialport.c b/serialport.c index 290786a..074534e 100644 --- a/serialport.c +++ b/serialport.c @@ -24,7 +24,7 @@ #include "libserialport.h" #include "libserialport_internal.h" -const struct std_baudrate std_baudrates[] = { +static const struct std_baudrate std_baudrates[] = { #ifdef _WIN32 /* * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to @@ -44,6 +44,8 @@ const struct std_baudrate std_baudrates[] = { #endif }; +#define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates) + void (*sp_debug_handler)(const char *format, ...) = sp_default_debug_handler; static enum sp_return get_config(struct sp_port *port, struct port_data *data, @@ -52,10 +54,12 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data, static enum sp_return set_config(struct sp_port *port, struct port_data *data, const struct sp_port_config *config); -enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr) +SP_API enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr) { struct sp_port *port; +#ifndef NO_PORT_METADATA enum sp_return ret; +#endif int len; TRACE("%s, %p", portname, port_ptr); @@ -68,7 +72,7 @@ enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_p if (!portname) RETURN_ERROR(SP_ERR_ARG, "Null port name"); - DEBUG("Building structure for port %s", portname); + DEBUG_FMT("Building structure for port %s", portname); if (!(port = malloc(sizeof(struct sp_port)))) RETURN_ERROR(SP_ERR_MEM, "Port structure malloc failed"); @@ -83,6 +87,7 @@ enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_p memcpy(port->name, portname, len); #ifdef _WIN32 + port->usb_path = NULL; port->hdl = INVALID_HANDLE_VALUE; #else port->fd = -1; @@ -111,38 +116,38 @@ enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_p RETURN_OK(); } -char *sp_get_port_name(const struct sp_port *port) +SP_API char *sp_get_port_name(const struct sp_port *port) { TRACE("%p", port); if (!port) return NULL; - RETURN_VALUE("%s", port->name); + RETURN_STRING(port->name); } -char *sp_get_port_description(struct sp_port *port) +SP_API char *sp_get_port_description(const struct sp_port *port) { TRACE("%p", port); if (!port || !port->description) return NULL; - RETURN_VALUE("%s", port->description); + RETURN_STRING(port->description); } -enum sp_transport sp_get_port_transport(struct sp_port *port) +SP_API enum sp_transport sp_get_port_transport(const struct sp_port *port) { TRACE("%p", port); if (!port) RETURN_ERROR(SP_ERR_ARG, "Null port"); - RETURN_VALUE("%d", port->transport); + RETURN_INT(port->transport); } -enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port, - int *usb_bus, int *usb_address) +SP_API enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port, + int *usb_bus,int *usb_address) { TRACE("%p", port); @@ -153,14 +158,16 @@ enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port, if (port->usb_bus < 0 || port->usb_address < 0) RETURN_ERROR(SP_ERR_SUPP, "Bus and address values are not available"); - if (usb_bus) *usb_bus = port->usb_bus; - if (usb_address) *usb_address = port->usb_address; + if (usb_bus) + *usb_bus = port->usb_bus; + if (usb_address) + *usb_address = port->usb_address; RETURN_OK(); } -enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port, - int *usb_vid, int *usb_pid) +SP_API enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port, + int *usb_vid, int *usb_pid) { TRACE("%p", port); @@ -171,43 +178,45 @@ enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port, if (port->usb_vid < 0 || port->usb_pid < 0) RETURN_ERROR(SP_ERR_SUPP, "VID:PID values are not available"); - if (usb_vid) *usb_vid = port->usb_vid; - if (usb_pid) *usb_pid = port->usb_pid; + if (usb_vid) + *usb_vid = port->usb_vid; + if (usb_pid) + *usb_pid = port->usb_pid; RETURN_OK(); } -char *sp_get_port_usb_manufacturer(const struct sp_port *port) +SP_API char *sp_get_port_usb_manufacturer(const struct sp_port *port) { TRACE("%p", port); if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_manufacturer) return NULL; - RETURN_VALUE("%s", port->usb_manufacturer); + RETURN_STRING(port->usb_manufacturer); } -char *sp_get_port_usb_product(const struct sp_port *port) +SP_API char *sp_get_port_usb_product(const struct sp_port *port) { TRACE("%p", port); if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_product) return NULL; - RETURN_VALUE("%s", port->usb_product); + RETURN_STRING(port->usb_product); } -char *sp_get_port_usb_serial(const struct sp_port *port) +SP_API char *sp_get_port_usb_serial(const struct sp_port *port) { TRACE("%p", port); if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_serial) return NULL; - RETURN_VALUE("%s", port->usb_serial); + RETURN_STRING(port->usb_serial); } -char *sp_get_port_bluetooth_address(const struct sp_port *port) +SP_API char *sp_get_port_bluetooth_address(const struct sp_port *port) { TRACE("%p", port); @@ -215,10 +224,11 @@ char *sp_get_port_bluetooth_address(const struct sp_port *port) || !port->bluetooth_address) return NULL; - RETURN_VALUE("%s", port->bluetooth_address); + RETURN_STRING(port->bluetooth_address); } -enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr) +SP_API enum sp_return sp_get_port_handle(const struct sp_port *port, + void *result_ptr) { TRACE("%p, %p", port, result_ptr); @@ -236,7 +246,8 @@ enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr) RETURN_OK(); } -enum sp_return sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr) +SP_API enum sp_return sp_copy_port(const struct sp_port *port, + struct sp_port **copy_ptr) { TRACE("%p, %p", port, copy_ptr); @@ -253,10 +264,10 @@ enum sp_return sp_copy_port(const struct sp_port *port, struct sp_port **copy_pt DEBUG("Copying port structure"); - RETURN_VALUE("%p", sp_get_port_by_name(port->name, copy_ptr)); + RETURN_INT(sp_get_port_by_name(port->name, copy_ptr)); } -void sp_free_port(struct sp_port *port) +SP_API void sp_free_port(struct sp_port *port) { TRACE("%p", port); @@ -289,7 +300,8 @@ void sp_free_port(struct sp_port *port) RETURN(); } -struct sp_port **list_append(struct sp_port **list, const char *portname) +SP_PRIV struct sp_port **list_append(struct sp_port **list, + const char *portname) { void *tmp; unsigned int count; @@ -308,44 +320,42 @@ fail: return NULL; } -enum sp_return sp_list_ports(struct sp_port ***list_ptr) +SP_API enum sp_return sp_list_ports(struct sp_port ***list_ptr) { +#ifndef NO_ENUMERATION struct sp_port **list; int ret; +#endif TRACE("%p", list_ptr); if (!list_ptr) RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); +#ifdef NO_ENUMERATION + RETURN_ERROR(SP_ERR_SUPP, "Enumeration not supported on this platform"); +#else DEBUG("Enumerating ports"); - if (!(list = malloc(sizeof(struct sp_port **)))) + if (!(list = malloc(sizeof(struct sp_port *)))) RETURN_ERROR(SP_ERR_MEM, "Port list malloc failed"); list[0] = NULL; -#ifdef NO_ENUMERATION - ret = SP_ERR_SUPP; -#else ret = list_ports(&list); -#endif - switch (ret) { - case SP_OK: + if (ret == SP_OK) { *list_ptr = list; - 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); + } else { + sp_free_port_list(list); *list_ptr = NULL; - return ret; } + + RETURN_CODEVAL(ret); +#endif } -void sp_free_port_list(struct sp_port **list) +SP_API void sp_free_port_list(struct sp_port **list) { unsigned int i; @@ -366,9 +376,9 @@ void sp_free_port_list(struct sp_port **list) } #define CHECK_PORT() do { \ - if (port == NULL) \ + if (!port) \ RETURN_ERROR(SP_ERR_ARG, "Null port"); \ - if (port->name == NULL) \ + if (!port->name) \ RETURN_ERROR(SP_ERR_ARG, "Null port name"); \ } while (0) #ifdef _WIN32 @@ -387,7 +397,44 @@ void sp_free_port_list(struct sp_port **list) CHECK_PORT_HANDLE(); \ } while (0) -enum sp_return sp_open(struct sp_port *port, enum sp_mode flags) +#ifdef WIN32 +/** To be called after port receive buffer is emptied. */ +static enum sp_return restart_wait(struct sp_port *port) +{ + DWORD wait_result; + + if (port->wait_running) { + /* Check status of running wait operation. */ + if (GetOverlappedResult(port->hdl, &port->wait_ovl, + &wait_result, FALSE)) { + DEBUG("Previous wait completed"); + port->wait_running = FALSE; + } else if (GetLastError() == ERROR_IO_INCOMPLETE) { + DEBUG("Previous wait still running"); + RETURN_OK(); + } else { + RETURN_FAIL("GetOverlappedResult() failed"); + } + } + + if (!port->wait_running) { + /* Start new wait operation. */ + if (WaitCommEvent(port->hdl, &port->events, + &port->wait_ovl)) { + DEBUG("New wait returned, events already pending"); + } else if (GetLastError() == ERROR_IO_PENDING) { + DEBUG("New wait running in background"); + port->wait_running = TRUE; + } else { + RETURN_FAIL("WaitCommEvent() failed"); + } + } + + RETURN_OK(); +} +#endif + +SP_API enum sp_return sp_open(struct sp_port *port, enum sp_mode flags) { struct port_data data; struct sp_port_config config; @@ -397,10 +444,10 @@ enum sp_return sp_open(struct sp_port *port, enum sp_mode flags) CHECK_PORT(); - if (flags > (SP_MODE_READ | SP_MODE_WRITE)) + if (flags > SP_MODE_READ_WRITE) RETURN_ERROR(SP_ERR_ARG, "Invalid flags"); - DEBUG("Opening port %s", port->name); + DEBUG_FMT("Opening port %s", port->name); #ifdef _WIN32 DWORD desired_access = 0, flags_and_attributes = 0, errors; @@ -425,7 +472,7 @@ enum sp_return sp_open(struct sp_port *port, enum sp_mode flags) free(escaped_port_name); if (port->hdl == INVALID_HANDLE_VALUE) - RETURN_FAIL("port CreateFile() failed"); + RETURN_FAIL("Port CreateFile() failed"); /* All timeouts initially disabled. */ port->timeouts.ReadIntervalTimeout = 0; @@ -460,21 +507,20 @@ enum sp_return sp_open(struct sp_port *port, enum sp_mode flags) RETURN_FAIL("SetCommMask() failed"); } - /* Start background operation for RX and error events. */ - if (WaitCommEvent(port->hdl, &port->events, &port->wait_ovl) == 0) { - if (GetLastError() != ERROR_IO_PENDING) { - sp_close(port); - RETURN_FAIL("WaitCommEvent() failed"); - } - } - port->writing = FALSE; + port->wait_running = FALSE; + + ret = restart_wait(port); + if (ret < 0) { + sp_close(port); + RETURN_CODEVAL(ret); + } #else int flags_local = O_NONBLOCK | O_NOCTTY; /* Map 'flags' to the OS-specific settings. */ - if (flags & (SP_MODE_READ | SP_MODE_WRITE)) + if ((flags & SP_MODE_READ_WRITE) == SP_MODE_READ_WRITE) flags_local |= O_RDWR; else if (flags & SP_MODE_READ) flags_local |= O_RDONLY; @@ -498,7 +544,7 @@ enum sp_return sp_open(struct sp_port *port, enum sp_mode flags) data.dcb.fDsrSensitivity = FALSE; data.dcb.fErrorChar = FALSE; data.dcb.fNull = FALSE; - data.dcb.fAbortOnError = TRUE; + data.dcb.fAbortOnError = FALSE; #else /* Turn off all fancy termios tricks, give us a raw channel. */ data.term.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP | INLCR | IGNCR | ICRNL | IMAXBEL); @@ -553,18 +599,18 @@ enum sp_return sp_open(struct sp_port *port, enum sp_mode flags) RETURN_OK(); } -enum sp_return sp_close(struct sp_port *port) +SP_API enum sp_return sp_close(struct sp_port *port) { TRACE("%p", port); CHECK_OPEN_PORT(); - DEBUG("Closing port %s", port->name); + DEBUG_FMT("Closing port %s", port->name); #ifdef _WIN32 /* Returns non-zero upon success, 0 upon failure. */ if (CloseHandle(port->hdl) == 0) - RETURN_FAIL("port CloseHandle() failed"); + RETURN_FAIL("Port CloseHandle() failed"); port->hdl = INVALID_HANDLE_VALUE; /* Close event handles for overlapped structures. */ @@ -587,7 +633,7 @@ enum sp_return sp_close(struct sp_port *port) RETURN_OK(); } -enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers) +SP_API enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers) { TRACE("%p, 0x%x", port, buffers); @@ -598,7 +644,8 @@ enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers) const char *buffer_names[] = {"no", "input", "output", "both"}; - DEBUG("Flushing %s buffers on port %s", buffer_names[buffers], port->name); + DEBUG_FMT("Flushing %s buffers on port %s", + buffer_names[buffers], port->name); #ifdef _WIN32 DWORD flags = 0; @@ -610,13 +657,16 @@ 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_FAIL("PurgeComm() failed"); + + if (buffers & SP_BUF_INPUT) + TRY(restart_wait(port)); #else int flags = 0; - if (buffers & SP_BUF_BOTH) + if (buffers == SP_BUF_BOTH) flags = TCIOFLUSH; - else if (buffers & SP_BUF_INPUT) + else if (buffers == SP_BUF_INPUT) flags = TCIFLUSH; - else if (buffers & SP_BUF_OUTPUT) + else if (buffers == SP_BUF_OUTPUT) flags = TCOFLUSH; /* Returns 0 upon success, -1 upon failure. */ @@ -626,13 +676,13 @@ enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers) RETURN_OK(); } -enum sp_return sp_drain(struct sp_port *port) +SP_API enum sp_return sp_drain(struct sp_port *port) { TRACE("%p", port); CHECK_OPEN_PORT(); - DEBUG("Draining port %s", port->name); + DEBUG_FMT("Draining port %s", port->name); #ifdef _WIN32 /* Returns non-zero upon success, 0 upon failure. */ @@ -662,7 +712,8 @@ enum sp_return sp_drain(struct sp_port *port) #endif } -enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t count, unsigned int timeout) +SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, + size_t count, unsigned int timeout) { TRACE("%p, %p, %d, %d", port, buf, count, timeout); @@ -672,12 +723,14 @@ enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t c RETURN_ERROR(SP_ERR_ARG, "Null buffer"); if (timeout) - DEBUG("Writing %d bytes to port %s, timeout %d ms", count, port->name, timeout); + DEBUG_FMT("Writing %d bytes to port %s, timeout %d ms", + count, port->name, timeout); else - DEBUG("Writing %d bytes to port %s, no timeout", count, port->name); + DEBUG_FMT("Writing %d bytes to port %s, no timeout", + count, port->name); if (count == 0) - RETURN_VALUE("0", 0); + RETURN_INT(0); #ifdef _WIN32 DWORD bytes_written = 0; @@ -703,14 +756,14 @@ enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t c if (GetLastError() == ERROR_IO_PENDING) { DEBUG("Waiting for write to complete"); GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE); - DEBUG("Write completed, %d/%d bytes written", bytes_written, count); - RETURN_VALUE("%d", bytes_written); + DEBUG_FMT("Write completed, %d/%d bytes written", bytes_written, count); + RETURN_INT(bytes_written); } else { RETURN_FAIL("WriteFile() failed"); } } else { DEBUG("Write completed immediately"); - RETURN_VALUE("%d", count); + RETURN_INT(count); } #else size_t bytes_written = 0; @@ -730,16 +783,15 @@ enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t c } /* Loop until we have written the requested number of bytes. */ - while (bytes_written < count) - { + while (bytes_written < count) { /* Wait until space is available. */ FD_ZERO(&fds); FD_SET(port->fd, &fds); if (timeout) { gettimeofday(&now, NULL); if (timercmp(&now, &end, >)) { - DEBUG("write timed out"); - RETURN_VALUE("%d", bytes_written); + DEBUG("Write timed out"); + RETURN_INT(bytes_written); } timersub(&end, &now, &delta); } @@ -752,8 +804,8 @@ enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t c RETURN_FAIL("select() failed"); } } else if (result == 0) { - DEBUG("write timed out"); - RETURN_VALUE("%d", bytes_written); + DEBUG("Write timed out"); + RETURN_INT(bytes_written); } /* Do write. */ @@ -772,11 +824,12 @@ enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t c ptr += result; } - RETURN_VALUE("%d", bytes_written); + RETURN_INT(bytes_written); #endif } -enum sp_return sp_nonblocking_write(struct sp_port *port, const void *buf, size_t count) +SP_API enum sp_return sp_nonblocking_write(struct sp_port *port, + const void *buf, size_t count) { TRACE("%p, %p, %d", port, buf, count); @@ -785,10 +838,10 @@ enum sp_return sp_nonblocking_write(struct sp_port *port, const void *buf, size_ if (!buf) RETURN_ERROR(SP_ERR_ARG, "Null buffer"); - DEBUG("Writing up to %d bytes to port %s", count, port->name); + DEBUG_FMT("Writing up to %d bytes to port %s", count, port->name); if (count == 0) - RETURN_VALUE("0", 0); + RETURN_INT(0); #ifdef _WIN32 DWORD written = 0; @@ -802,7 +855,7 @@ enum sp_return sp_nonblocking_write(struct sp_port *port, const void *buf, size_ } else { DEBUG("Previous write not complete"); /* Can't take a new write until the previous one finishes. */ - RETURN_VALUE("0", 0); + RETURN_INT(0); } } @@ -811,10 +864,11 @@ enum sp_return sp_nonblocking_write(struct sp_port *port, const void *buf, size_ if (SetCommTimeouts(port->hdl, &port->timeouts) == 0) RETURN_FAIL("SetCommTimeouts() failed"); - /* 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) - { + /* + * 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++; @@ -829,7 +883,7 @@ enum sp_return sp_nonblocking_write(struct sp_port *port, const void *buf, size_ } else { DEBUG("Asynchronous write running"); port->writing = 1; - RETURN_VALUE("%d", ++written); + RETURN_INT(++written); } } else { /* Actual failure of some kind. */ @@ -843,7 +897,7 @@ enum sp_return sp_nonblocking_write(struct sp_port *port, const void *buf, size_ DEBUG("All bytes written immediately"); - RETURN_VALUE("%d", written); + RETURN_INT(written); #else /* Returns the number of bytes written, or -1 upon failure. */ ssize_t written = write(port->fd, buf, count); @@ -851,11 +905,12 @@ enum sp_return sp_nonblocking_write(struct sp_port *port, const void *buf, size_ if (written < 0) RETURN_FAIL("write() failed"); else - RETURN_VALUE("%d", written); + RETURN_INT(written); #endif } -enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, unsigned int timeout) +SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf, + size_t count, unsigned int timeout) { TRACE("%p, %p, %d, %d", port, buf, count, timeout); @@ -865,15 +920,19 @@ enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, u RETURN_ERROR(SP_ERR_ARG, "Null buffer"); if (timeout) - DEBUG("Reading %d bytes from port %s, timeout %d ms", count, port->name, timeout); + DEBUG_FMT("Reading %d bytes from port %s, timeout %d ms", + count, port->name, timeout); else - DEBUG("Reading %d bytes from port %s, no timeout", count, port->name); + DEBUG_FMT("Reading %d bytes from port %s, no timeout", + count, port->name); if (count == 0) - RETURN_VALUE("0", 0); + RETURN_INT(0); #ifdef _WIN32 DWORD bytes_read = 0; + DWORD bytes_remaining; + int ret; /* Set timeout. */ port->timeouts.ReadIntervalTimeout = 0; @@ -886,7 +945,7 @@ enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, u if (GetLastError() == ERROR_IO_PENDING) { DEBUG("Waiting for read to complete"); GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE); - DEBUG("Read completed, %d/%d bytes read", bytes_read, count); + DEBUG_FMT("Read completed, %d/%d bytes read", bytes_read, count); } else { RETURN_FAIL("ReadFile() failed"); } @@ -895,13 +954,18 @@ enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, u bytes_read = count; } - /* Start background operation for subsequent events. */ - if (WaitCommEvent(port->hdl, &port->events, &port->wait_ovl) == 0) { - if (GetLastError() != ERROR_IO_PENDING) - RETURN_FAIL("WaitCommEvent() failed"); - } + ret = sp_input_waiting(port); - RETURN_VALUE("%d", bytes_read); + if (ret < 0) + RETURN_CODEVAL(ret); + + bytes_remaining = ret; + + /* Restart wait operation if buffer was emptied. */ + if (bytes_read > 0 && bytes_remaining == 0) + TRY(restart_wait(port)); + + RETURN_INT(bytes_read); #else size_t bytes_read = 0; @@ -921,8 +985,7 @@ enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, u } /* Loop until we have the requested number of bytes. */ - while (bytes_read < count) - { + while (bytes_read < count) { /* Wait until data is available. */ FD_ZERO(&fds); FD_SET(port->fd, &fds); @@ -930,7 +993,7 @@ enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, u gettimeofday(&now, NULL); if (timercmp(&now, &end, >)) /* Timeout has expired. */ - RETURN_VALUE("%d", bytes_read); + RETURN_INT(bytes_read); timersub(&end, &now, &delta); } result = select(port->fd + 1, &fds, NULL, NULL, timeout ? &delta : NULL); @@ -942,8 +1005,8 @@ enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, u RETURN_FAIL("select() failed"); } } else if (result == 0) { - DEBUG("read timed out"); - RETURN_VALUE("%d", bytes_read); + DEBUG("Read timed out"); + RETURN_INT(bytes_read); } /* Do read. */ @@ -962,11 +1025,12 @@ enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, u ptr += result; } - RETURN_VALUE("%d", bytes_read); + RETURN_INT(bytes_read); #endif } -enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count) +SP_API enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, + size_t count) { TRACE("%p, %p, %d", port, buf, count); @@ -975,10 +1039,12 @@ enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count if (!buf) RETURN_ERROR(SP_ERR_ARG, "Null buffer"); - DEBUG("Reading up to %d bytes from port %s", count, port->name); + DEBUG_FMT("Reading up to %d bytes from port %s", count, port->name); #ifdef _WIN32 DWORD bytes_read; + DWORD bytes_remaining; + int ret; /* Set timeout. */ port->timeouts.ReadIntervalTimeout = MAXDWORD; @@ -994,15 +1060,18 @@ enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE) == 0) RETURN_FAIL("GetOverlappedResult() failed"); - if (bytes_read > 0) { - /* Start background operation for subsequent events. */ - if (WaitCommEvent(port->hdl, &port->events, &port->wait_ovl) == 0) { - if (GetLastError() != ERROR_IO_PENDING) - RETURN_FAIL("WaitCommEvent() failed"); - } - } + ret = sp_input_waiting(port); - RETURN_VALUE("%d", bytes_read); + if (ret < 0) + RETURN_CODEVAL(ret); + + bytes_remaining = ret; + + /* Restart wait operation if buffer was emptied. */ + if (bytes_read > 0 && bytes_remaining == 0) + TRY(restart_wait(port)); + + RETURN_INT(bytes_read); #else ssize_t bytes_read; @@ -1015,17 +1084,17 @@ enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count /* This is an actual failure. */ RETURN_FAIL("read() failed"); } - RETURN_VALUE("%d", bytes_read); + RETURN_INT(bytes_read); #endif } -enum sp_return sp_input_waiting(struct sp_port *port) +SP_API enum sp_return sp_input_waiting(struct sp_port *port) { TRACE("%p", port); CHECK_OPEN_PORT(); - DEBUG("Checking input bytes waiting on port %s", port->name); + DEBUG_FMT("Checking input bytes waiting on port %s", port->name); #ifdef _WIN32 DWORD errors; @@ -1033,22 +1102,22 @@ enum sp_return sp_input_waiting(struct sp_port *port) if (ClearCommError(port->hdl, &errors, &comstat) == 0) RETURN_FAIL("ClearCommError() failed"); - RETURN_VALUE("%d", comstat.cbInQue); + RETURN_INT(comstat.cbInQue); #else int bytes_waiting; if (ioctl(port->fd, TIOCINQ, &bytes_waiting) < 0) RETURN_FAIL("TIOCINQ ioctl failed"); - RETURN_VALUE("%d", bytes_waiting); + RETURN_INT(bytes_waiting); #endif } -enum sp_return sp_output_waiting(struct sp_port *port) +SP_API enum sp_return sp_output_waiting(struct sp_port *port) { TRACE("%p", port); CHECK_OPEN_PORT(); - DEBUG("Checking output bytes waiting on port %s", port->name); + DEBUG_FMT("Checking output bytes waiting on port %s", port->name); #ifdef _WIN32 DWORD errors; @@ -1056,16 +1125,16 @@ enum sp_return sp_output_waiting(struct sp_port *port) if (ClearCommError(port->hdl, &errors, &comstat) == 0) RETURN_FAIL("ClearCommError() failed"); - RETURN_VALUE("%d", comstat.cbOutQue); + RETURN_INT(comstat.cbOutQue); #else int bytes_waiting; if (ioctl(port->fd, TIOCOUTQ, &bytes_waiting) < 0) RETURN_FAIL("TIOCOUTQ ioctl failed"); - RETURN_VALUE("%d", bytes_waiting); + RETURN_INT(bytes_waiting); #endif } -enum sp_return sp_new_event_set(struct sp_event_set **result_ptr) +SP_API enum sp_return sp_new_event_set(struct sp_event_set **result_ptr) { struct sp_event_set *result; @@ -1096,13 +1165,14 @@ static enum sp_return add_handle(struct sp_event_set *event_set, if (!(new_handles = realloc(event_set->handles, sizeof(event_handle) * (event_set->count + 1)))) - RETURN_ERROR(SP_ERR_MEM, "handle array realloc() failed"); + RETURN_ERROR(SP_ERR_MEM, "Handle array realloc() failed"); + + event_set->handles = new_handles; if (!(new_masks = realloc(event_set->masks, sizeof(enum sp_event) * (event_set->count + 1)))) - RETURN_ERROR(SP_ERR_MEM, "mask array realloc() failed"); + RETURN_ERROR(SP_ERR_MEM, "Mask array realloc() failed"); - event_set->handles = new_handles; event_set->masks = new_masks; ((event_handle *) event_set->handles)[event_set->count] = handle; @@ -1113,7 +1183,7 @@ static enum sp_return add_handle(struct sp_event_set *event_set, RETURN_OK(); } -enum sp_return sp_add_port_events(struct sp_event_set *event_set, +SP_API enum sp_return sp_add_port_events(struct sp_event_set *event_set, const struct sp_port *port, enum sp_event mask) { TRACE("%p, %p, %d", event_set, port, mask); @@ -1143,7 +1213,7 @@ enum sp_return sp_add_port_events(struct sp_event_set *event_set, RETURN_OK(); } -void sp_free_event_set(struct sp_event_set *event_set) +SP_API void sp_free_event_set(struct sp_event_set *event_set) { TRACE("%p", event_set); @@ -1164,7 +1234,8 @@ void sp_free_event_set(struct sp_event_set *event_set) RETURN(); } -enum sp_return sp_wait(struct sp_event_set *event_set, unsigned int timeout) +SP_API enum sp_return sp_wait(struct sp_event_set *event_set, + unsigned int timeout) { TRACE("%p, %d", event_set, timeout); @@ -1209,12 +1280,11 @@ enum sp_return sp_wait(struct sp_event_set *event_set, unsigned int timeout) } /* Loop until an event occurs. */ - while (1) - { + while (1) { if (timeout) { gettimeofday(&now, NULL); if (timercmp(&now, &end, >)) { - DEBUG("wait timed out"); + DEBUG("Wait timed out"); break; } timersub(&end, &now, &delta); @@ -1259,7 +1329,7 @@ static enum sp_return get_baudrate(int fd, int *baudrate) if (ioctl(fd, get_termios_get_ioctl(), data) < 0) { free(data); - RETURN_FAIL("getting termios failed"); + RETURN_FAIL("Getting termios failed"); } *baudrate = get_termios_speed(data); @@ -1282,7 +1352,7 @@ static enum sp_return set_baudrate(int fd, int baudrate) if (ioctl(fd, get_termios_get_ioctl(), data) < 0) { free(data); - RETURN_FAIL("getting termios failed"); + RETURN_FAIL("Getting termios failed"); } DEBUG("Setting baud rate"); @@ -1291,7 +1361,7 @@ static enum sp_return set_baudrate(int fd, int baudrate) if (ioctl(fd, get_termios_set_ioctl(), data) < 0) { free(data); - RETURN_FAIL("setting termios failed"); + RETURN_FAIL("Setting termios failed"); } free(data); @@ -1314,7 +1384,7 @@ static enum sp_return get_flow(int fd, struct port_data *data) if (ioctl(fd, TCGETX, termx) < 0) { free(termx); - RETURN_FAIL("getting termiox failed"); + RETURN_FAIL("Getting termiox failed"); } get_termiox_flow(termx, &data->rts_flow, &data->cts_flow, @@ -1338,7 +1408,7 @@ static enum sp_return set_flow(int fd, struct port_data *data) if (ioctl(fd, TCGETX, termx) < 0) { free(termx); - RETURN_FAIL("getting termiox failed"); + RETURN_FAIL("Getting termiox failed"); } DEBUG("Setting advanced flow control"); @@ -1348,7 +1418,7 @@ static enum sp_return set_flow(int fd, struct port_data *data) if (ioctl(fd, TCSETX, termx) < 0) { free(termx); - RETURN_FAIL("setting termiox failed"); + RETURN_FAIL("Setting termiox failed"); } free(termx); @@ -1364,7 +1434,7 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data, TRACE("%p, %p, %p", port, data, config); - DEBUG("Getting configuration for port %s", port->name); + DEBUG_FMT("Getting configuration for port %s", port->name); #ifdef _WIN32 if (!GetCommState(port->hdl, &data->dcb)) @@ -1581,7 +1651,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, TRACE("%p, %p, %p", port, data, config); - DEBUG("Setting configuration for port %s", port->name); + DEBUG_FMT("Setting configuration for port %s", port->name); #ifdef _WIN32 if (config->baudrate >= 0) { @@ -1932,8 +2002,10 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, if (baud_nonstd != B0) { if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1) RETURN_FAIL("IOSSIOSPEED ioctl failed"); - /* Set baud rates in data->term to correct, but incompatible - * with tcsetattr() value, same as delivered by tcgetattr(). */ + /* + * 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_FAIL("cfsetspeed() failed"); } @@ -1953,7 +2025,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, RETURN_OK(); } -enum sp_return sp_new_config(struct sp_port_config **config_ptr) +SP_API enum sp_return sp_new_config(struct sp_port_config **config_ptr) { struct sp_port_config *config; @@ -1965,7 +2037,7 @@ enum sp_return sp_new_config(struct sp_port_config **config_ptr) *config_ptr = NULL; if (!(config = malloc(sizeof(struct sp_port_config)))) - RETURN_ERROR(SP_ERR_MEM, "config malloc failed"); + RETURN_ERROR(SP_ERR_MEM, "Config malloc failed"); config->baudrate = -1; config->bits = -1; @@ -1981,7 +2053,7 @@ enum sp_return sp_new_config(struct sp_port_config **config_ptr) RETURN_OK(); } -void sp_free_config(struct sp_port_config *config) +SP_API void sp_free_config(struct sp_port_config *config) { TRACE("%p", config); @@ -1993,7 +2065,8 @@ void sp_free_config(struct sp_port_config *config) RETURN(); } -enum sp_return sp_get_config(struct sp_port *port, struct sp_port_config *config) +SP_API enum sp_return sp_get_config(struct sp_port *port, + struct sp_port_config *config) { struct port_data data; @@ -2009,7 +2082,8 @@ enum sp_return sp_get_config(struct sp_port *port, struct sp_port_config *config RETURN_OK(); } -enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *config) +SP_API enum sp_return sp_set_config(struct sp_port *port, + const struct sp_port_config *config) { struct port_data data; struct sp_port_config prev_config; @@ -2028,7 +2102,7 @@ enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config * } #define CREATE_ACCESSORS(x, type) \ -enum sp_return sp_set_##x(struct sp_port *port, type x) { \ +SP_API enum sp_return sp_set_##x(struct sp_port *port, type x) { \ struct port_data data; \ struct sp_port_config config; \ TRACE("%p, %d", port, x); \ @@ -2038,14 +2112,16 @@ enum sp_return sp_set_##x(struct sp_port *port, type x) { \ TRY(set_config(port, &data, &config)); \ RETURN_OK(); \ } \ -enum sp_return sp_get_config_##x(const struct sp_port_config *config, type *x) { \ +SP_API enum sp_return sp_get_config_##x(const struct sp_port_config *config, \ + type *x) { \ TRACE("%p, %p", config, x); \ 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) { \ +SP_API 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"); \ @@ -2063,7 +2139,8 @@ 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) +SP_API enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config, + enum sp_flowcontrol flowcontrol) { if (!config) RETURN_ERROR(SP_ERR_ARG, "Null configuration"); @@ -2097,7 +2174,8 @@ enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config, enum sp_ RETURN_OK(); } -enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol) +SP_API enum sp_return sp_set_flowcontrol(struct sp_port *port, + enum sp_flowcontrol flowcontrol) { struct port_data data; struct sp_port_config config; @@ -2115,7 +2193,8 @@ enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flow RETURN_OK(); } -enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals) +SP_API enum sp_return sp_get_signals(struct sp_port *port, + enum sp_signal *signals) { TRACE("%p, %p", port, signals); @@ -2124,7 +2203,7 @@ enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals) if (!signals) RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); - DEBUG("Getting control signals for port %s", port->name); + DEBUG_FMT("Getting control signals for port %s", port->name); *signals = 0; #ifdef _WIN32 @@ -2155,7 +2234,7 @@ enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals) RETURN_OK(); } -enum sp_return sp_start_break(struct sp_port *port) +SP_API enum sp_return sp_start_break(struct sp_port *port) { TRACE("%p", port); @@ -2171,7 +2250,7 @@ enum sp_return sp_start_break(struct sp_port *port) RETURN_OK(); } -enum sp_return sp_end_break(struct sp_port *port) +SP_API enum sp_return sp_end_break(struct sp_port *port) { TRACE("%p", port); @@ -2187,19 +2266,19 @@ enum sp_return sp_end_break(struct sp_port *port) RETURN_OK(); } -int sp_last_error_code(void) +SP_API int sp_last_error_code(void) { - TRACE(""); + TRACE_VOID(); #ifdef _WIN32 - RETURN_VALUE("%d", GetLastError()); + RETURN_INT(GetLastError()); #else - RETURN_VALUE("%d", errno); + RETURN_INT(errno); #endif } -char *sp_last_error_message(void) +SP_API char *sp_last_error_message(void) { - TRACE(""); + TRACE_VOID(); #ifdef _WIN32 LPVOID message; @@ -2215,13 +2294,13 @@ char *sp_last_error_message(void) (LPTSTR) &message, 0, NULL ); - RETURN_VALUE("%s", message); + RETURN_STRING(message); #else - RETURN_VALUE("%s", strerror(errno)); + RETURN_STRING(strerror(errno)); #endif } -void sp_free_error_message(char *message) +SP_API void sp_free_error_message(char *message) { TRACE("%s", message); @@ -2234,7 +2313,7 @@ void sp_free_error_message(char *message) RETURN(); } -void sp_set_debug_handler(void (*handler)(const char *format, ...)) +SP_API void sp_set_debug_handler(void (*handler)(const char *format, ...)) { TRACE("%p", handler); @@ -2243,7 +2322,7 @@ void sp_set_debug_handler(void (*handler)(const char *format, ...)) RETURN(); } -void sp_default_debug_handler(const char *format, ...) +SP_API void sp_default_debug_handler(const char *format, ...) { va_list args; va_start(args, format); @@ -2254,42 +2333,42 @@ void sp_default_debug_handler(const char *format, ...) va_end(args); } -int sp_get_major_package_version(void) +SP_API int sp_get_major_package_version(void) { return SP_PACKAGE_VERSION_MAJOR; } -int sp_get_minor_package_version(void) +SP_API int sp_get_minor_package_version(void) { return SP_PACKAGE_VERSION_MINOR; } -int sp_get_micro_package_version(void) +SP_API int sp_get_micro_package_version(void) { return SP_PACKAGE_VERSION_MICRO; } -const char *sp_get_package_version_string(void) +SP_API const char *sp_get_package_version_string(void) { return SP_PACKAGE_VERSION_STRING; } -int sp_get_current_lib_version(void) +SP_API int sp_get_current_lib_version(void) { return SP_LIB_VERSION_CURRENT; } -int sp_get_revision_lib_version(void) +SP_API int sp_get_revision_lib_version(void) { return SP_LIB_VERSION_REVISION; } -int sp_get_age_lib_version(void) +SP_API int sp_get_age_lib_version(void) { return SP_LIB_VERSION_AGE; } -const char *sp_get_lib_version_string(void) +SP_API const char *sp_get_lib_version_string(void) { return SP_LIB_VERSION_STRING; }