X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fserial.c;h=aa8d4ddedf3b383fadbdf06bedbe062ba67f24c4;hb=7db9027985c2d59eccb0a20979bf5d7c699c8c8b;hp=4fe9b88fc0805e43b7716a4cdd1ace37501620a4;hpb=98edee7926b9827eec743bbfbfde9025089dc502;p=libsigrok.git diff --git a/src/serial.c b/src/serial.c index 4fe9b88f..aa8d4dde 100644 --- a/src/serial.c +++ b/src/serial.c @@ -4,6 +4,7 @@ * Copyright (C) 2010-2012 Bert Vermeulen * Copyright (C) 2010-2012 Uwe Hermann * Copyright (C) 2012 Alexandru Gagniuc + * Copyright (C) 2014 Uffe Jakobsen * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -19,28 +20,50 @@ * along with this program. If not, see . */ +#include #include #include #include #include #include -#include "libsigrok.h" +#include #include "libsigrok-internal.h" +#ifdef G_OS_WIN32 +#include /* for HANDLE */ +#endif +/** @cond PRIVATE */ #define LOG_PREFIX "serial" +/** @endcond */ + +/** + * @file + * + * Serial port handling. + */ + +/** + * @defgroup grp_serial Serial port handling + * + * Serial port handling functions. + * + * @{ + */ /** * Open the specified serial port. * * @param serial Previously initialized serial port structure. * @param[in] flags Flags to use when opening the serial port. Possible flags - * include SERIAL_RDWR, SERIAL_RDONLY. + * include SERIAL_RDWR, SERIAL_RDONLY. * * If the serial structure contains a serialcomm string, it will be * passed to serial_set_paramstr() after the port is opened. * * @retval SR_OK Success. * @retval SR_ERR Failure. + * + * @private */ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags) { @@ -89,6 +112,8 @@ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags) * * @retval SR_OK Success. * @retval SR_ERR Failure. + * + * @private */ SR_PRIV int serial_close(struct sr_serial_dev_inst *serial) { @@ -134,6 +159,8 @@ SR_PRIV int serial_close(struct sr_serial_dev_inst *serial) * * @retval SR_OK Success. * @retval SR_ERR Failure. + * + * @private */ SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial) { @@ -169,8 +196,48 @@ SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial) return SR_OK; } +/** + * Drain serial port buffers. + * + * @param serial Previously initialized serial port structure. + * + * @retval SR_OK Success. + * @retval SR_ERR Failure. + * + * @private + */ +SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial) +{ + int ret; + char *error; + + if (!serial) { + sr_dbg("Invalid serial port."); + return SR_ERR; + } + + if (!serial->data) { + sr_dbg("Cannot drain unopened serial port %s.", serial->port); + return SR_ERR; + } + + sr_spew("Draining serial port %s.", serial->port); + + ret = sp_drain(serial->data); + + if (ret == SP_ERR_FAIL) { + error = sp_last_error_message(); + sr_err("Error draining port (%d): %s.", + sp_last_error_code(), error); + sp_free_error_message(error); + return SR_ERR; + } + + return SR_OK; +} + static int _serial_write(struct sr_serial_dev_inst *serial, - const void *buf, size_t count, int nonblocking) + const void *buf, size_t count, int nonblocking, unsigned int timeout_ms) { ssize_t ret; char *error; @@ -188,7 +255,7 @@ static int _serial_write(struct sr_serial_dev_inst *serial, if (nonblocking) ret = sp_nonblocking_write(serial->data, buf, count); else - ret = sp_blocking_write(serial->data, buf, count, 0); + ret = sp_blocking_write(serial->data, buf, count, timeout_ms); switch (ret) { case SP_ERR_ARG: @@ -201,7 +268,7 @@ static int _serial_write(struct sr_serial_dev_inst *serial, return SR_ERR; } - sr_spew("Wrote %d/%d bytes.", ret, count); + sr_spew("Wrote %zd/%zu bytes.", ret, count); return ret; } @@ -212,15 +279,19 @@ static int _serial_write(struct sr_serial_dev_inst *serial, * @param serial Previously initialized serial port structure. * @param[in] buf Buffer containing the bytes to write. * @param[in] count Number of bytes to write. + * @param[in] timeout_ms Timeout in ms, or 0 for no timeout. * * @retval SR_ERR_ARG Invalid argument. * @retval SR_ERR Other error. - * @retval other The number of bytes written. + * @retval other The number of bytes written. If this is less than the number + * specified in the call, the timeout was reached. + * + * @private */ SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial, - const void *buf, size_t count) + const void *buf, size_t count, unsigned int timeout_ms) { - return _serial_write(serial, buf, count, 0); + return _serial_write(serial, buf, count, 0, timeout_ms); } /** @@ -233,15 +304,17 @@ SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial, * @retval SR_ERR_ARG Invalid argument. * @retval SR_ERR Other error. * @retval other The number of bytes written. -*/ + * + * @private + */ SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial, const void *buf, size_t count) { - return _serial_write(serial, buf, count, 1); + return _serial_write(serial, buf, count, 1, 0); } static int _serial_read(struct sr_serial_dev_inst *serial, void *buf, - size_t count, int nonblocking) + size_t count, int nonblocking, unsigned int timeout_ms) { ssize_t ret; char *error; @@ -259,7 +332,7 @@ static int _serial_read(struct sr_serial_dev_inst *serial, void *buf, if (nonblocking) ret = sp_nonblocking_read(serial->data, buf, count); else - ret = sp_blocking_read(serial->data, buf, count, 0); + ret = sp_blocking_read(serial->data, buf, count, timeout_ms); switch (ret) { case SP_ERR_ARG: @@ -273,7 +346,7 @@ static int _serial_read(struct sr_serial_dev_inst *serial, void *buf, } if (ret > 0) - sr_spew("Read %d/%d bytes.", ret, count); + sr_spew("Read %zd/%zu bytes.", ret, count); return ret; } @@ -284,15 +357,19 @@ static int _serial_read(struct sr_serial_dev_inst *serial, void *buf, * @param serial Previously initialized serial port structure. * @param buf Buffer where to store the bytes that are read. * @param[in] count The number of bytes to read. + * @param[in] timeout_ms Timeout in ms, or 0 for no timeout. * * @retval SR_ERR_ARG Invalid argument. - * @retval SR_ERR Other error. - * @retval other The number of bytes read. + * @retval SR_ERR Other error. + * @retval other The number of bytes read. If this is less than the number + * requested, the timeout was reached. + * + * @private */ SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf, - size_t count) + size_t count, unsigned int timeout_ms) { - return _serial_read(serial, buf, count, 0); + return _serial_read(serial, buf, count, 0, timeout_ms); } /** @@ -304,13 +381,15 @@ SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf, * @param[in] count The number of bytes to read. * * @retval SR_ERR_ARG Invalid argument. - * @retval SR_ERR Other error. - * @retval other The number of bytes read. + * @retval SR_ERR Other error. + * @retval other The number of bytes read. + * + * @private */ SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf, size_t count) { - return _serial_read(serial, buf, count, 1); + return _serial_read(serial, buf, count, 1, 0); } /** @@ -322,12 +401,14 @@ SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf * @param[in] parity The parity setting to use (0 = none, 1 = even, 2 = odd). * @param[in] stopbits The number of stop bits to use (1 or 2). * @param[in] flowcontrol The flow control settings to use (0 = none, - * 1 = RTS/CTS, 2 = XON/XOFF). + * 1 = RTS/CTS, 2 = XON/XOFF). * @param[in] rts Status of RTS line (0 or 1; required by some interfaces). * @param[in] dtr Status of DTR line (0 or 1; required by some interfaces). * * @retval SR_OK Success. * @retval SR_ERR Failure. + * + * @private */ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate, int bits, int parity, int stopbits, @@ -396,7 +477,7 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate, * @param serial Previously initialized serial port structure. * @param[in] paramstr A serial communication parameters string of the form * "/{/