X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=src%2Fserial.c;h=97bd3159b094f673e0db8070d87eadb960e1cab8;hp=27244da34b6513c6e0cc4b9461fd4d417b3f652b;hb=22fdb67fa0714c11cc0a58ee1423f55d18a4f080;hpb=6ec6c43b4738dbc7091f4a49a4ec80ea6102cb52 diff --git a/src/serial.c b/src/serial.c index 27244da3..97bd3159 100644 --- a/src/serial.c +++ b/src/serial.c @@ -5,6 +5,7 @@ * Copyright (C) 2010-2012 Uwe Hermann * Copyright (C) 2012 Alexandru Gagniuc * Copyright (C) 2014 Uffe Jakobsen + * Copyright (C) 2017-2019 Gerhard Sittig * * 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 @@ -25,10 +26,12 @@ #include #include #include +#ifdef HAVE_LIBSERIALPORT #include +#endif #include #include "libsigrok-internal.h" -#ifdef G_OS_WIN32 +#ifdef _WIN32 #include /* for HANDLE */ #endif @@ -50,12 +53,23 @@ * @{ */ +#ifdef HAVE_SERIAL_COMM + +/* See if an (assumed opened) serial port is of any supported type. */ +static int dev_is_supported(struct sr_serial_dev_inst *serial) +{ + if (!serial || !serial->lib_funcs) + return 0; + + return 1; +} + /** * 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. @@ -68,8 +82,6 @@ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags) { int ret; - char *error; - int sp_flags = 0; if (!serial) { sr_dbg("Invalid serial port."); @@ -78,31 +90,56 @@ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags) sr_spew("Opening serial port '%s' (flags %d).", serial->port, flags); - sp_get_port_by_name(serial->port, &serial->data); - - if (flags & SERIAL_RDWR) - sp_flags = (SP_MODE_READ | SP_MODE_WRITE); - else if (flags & SERIAL_RDONLY) - sp_flags = SP_MODE_READ; + /* + * Determine which serial transport library to use. Derive the + * variant from the serial port's name. Default to libserialport + * for backwards compatibility. + */ + if (ser_name_is_hid(serial)) + serial->lib_funcs = ser_lib_funcs_hid; + else if (ser_name_is_bt(serial)) + serial->lib_funcs = ser_lib_funcs_bt; + else + serial->lib_funcs = ser_lib_funcs_libsp; + if (!serial->lib_funcs) + return SR_ERR_NA; - ret = sp_open(serial->data, sp_flags); + /* + * Note that use of the 'rcv_buffer' is optional, and the buffer's + * size heavily depends on the specific transport. That's why the + * buffer's content gets accessed and the buffer is released here in + * common code, but the buffer gets allocated in libraries' open() + * routines. + */ - switch (ret) { - case SP_ERR_ARG: - sr_err("Attempt to open serial port with invalid parameters."); - return SR_ERR_ARG; - case SP_ERR_FAIL: - error = sp_last_error_message(); - sr_err("Error opening port (%d): %s.", - sp_last_error_code(), error); - sp_free_error_message(error); - return SR_ERR; + /* + * Run the transport's open routine. Setup the bitrate and the + * UART frame format. + */ + if (!serial->lib_funcs->open) + return SR_ERR_NA; + ret = serial->lib_funcs->open(serial, flags); + if (ret != SR_OK) + return ret; + + if (serial->serialcomm) { + ret = serial_set_paramstr(serial, serial->serialcomm); + if (ret != SR_OK) + return ret; } - if (serial->serialcomm) - return serial_set_paramstr(serial, serial->serialcomm); - else - return SR_OK; + /* + * Flush potentially dangling RX data. Availability of the + * flush primitive depends on the transport/cable, absense + * is non-fatal. + */ + ret = serial_flush(serial); + if (ret == SR_ERR_NA) + ret = SR_OK; + if (ret != SR_OK) + return ret; + + return SR_OK; } /** @@ -117,43 +154,29 @@ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags) */ SR_PRIV int serial_close(struct sr_serial_dev_inst *serial) { - int ret; - char *error; + int rc; if (!serial) { sr_dbg("Invalid serial port."); return SR_ERR; } - if (!serial->data) { - sr_dbg("Cannot close unopened serial port %s.", serial->port); - return SR_ERR; - } - sr_spew("Closing serial port %s.", serial->port); - ret = sp_close(serial->data); + if (!serial->lib_funcs || !serial->lib_funcs->close) + return SR_ERR_NA; - switch (ret) { - case SP_ERR_ARG: - sr_err("Attempt to close an invalid serial port."); - return SR_ERR_ARG; - case SP_ERR_FAIL: - error = sp_last_error_message(); - sr_err("Error closing port (%d): %s.", - sp_last_error_code(), error); - sp_free_error_message(error); - return SR_ERR; + rc = serial->lib_funcs->close(serial); + if (rc == SR_OK && serial->rcv_buffer) { + g_string_free(serial->rcv_buffer, TRUE); + serial->rcv_buffer = NULL; } - sp_free_port(serial->data); - serial->data = NULL; - - return SR_OK; + return rc; } /** - * Flush serial port buffers. + * Flush serial port buffers. Empty buffers, discard pending RX and TX data. * * @param serial Previously initialized serial port structure. * @@ -164,40 +187,23 @@ SR_PRIV int serial_close(struct sr_serial_dev_inst *serial) */ SR_PRIV int serial_flush(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 flush unopened serial port %s.", serial->port); - return SR_ERR; - } - sr_spew("Flushing serial port %s.", serial->port); - ret = sp_flush(serial->data, SP_BUF_BOTH); + sr_ser_discard_queued_data(serial); - switch (ret) { - case SP_ERR_ARG: - sr_err("Attempt to flush an invalid serial port."); - return SR_ERR_ARG; - case SP_ERR_FAIL: - error = sp_last_error_message(); - sr_err("Error flushing port (%d): %s.", - sp_last_error_code(), error); - sp_free_error_message(error); - return SR_ERR; - } + if (!serial->lib_funcs || !serial->lib_funcs->flush) + return SR_ERR_NA; - return SR_OK; + return serial->lib_funcs->flush(serial); } /** - * Drain serial port buffers. + * Drain serial port buffers. Wait for pending TX data to be sent. * * @param serial Previously initialized serial port structure. * @@ -208,66 +214,197 @@ SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial) */ 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 (!serial->lib_funcs || !serial->lib_funcs->drain) + return SR_ERR_NA; - 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 serial->lib_funcs->drain(serial); +} + +/* + * Provide an internal RX data buffer for the serial port. This is not + * supposed to be used directly by applications. Instead optional and + * alternative transports for serial communication can use this buffer + * if their progress is driven from background activity, and is not + * (directly) driven by external API calls. + * + * BEWARE! This implementation assumes that data which gets communicated + * via UART can get stored in a GString (which is a char array). Since + * the API hides this detail, we can address this issue later when needed. + * Callers use the API which communicates bytes. + * + * Applications optionally can register a "per RX chunk" callback, when + * they depend on the frame boundaries of the respective physical layer. + * Most callers just want the stream of RX data, and can use the buffer. + * + * The availability of RX chunks to callbacks, as well as the capability + * to pass on exact frames as chunks or potential re-assembly of chunks + * to a single data block, depend on each transport's implementation. + */ + +/** + * Register application callback for RX data chunks. + * + * @param[in] serial Previously initialized serial port instance. + * @param[in] cb Routine to call as RX data becomes available. + * @param[in] cb_data User data to pass to the callback in addition to RX data. + * + * @retval SR_ERR_ARG Invalid parameters. + * @retval SR_OK Successful registration. + * + * Callbacks get unregistered by specifying NULL for the 'cb' parameter. + * + * @private + */ +SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial, + serial_rx_chunk_callback cb, void *cb_data) +{ + if (!serial) + return SR_ERR_ARG; + + serial->rx_chunk_cb_func = cb; + serial->rx_chunk_cb_data = cb_data; return SR_OK; } -static int _serial_write(struct sr_serial_dev_inst *serial, - const void *buf, size_t count, int nonblocking, unsigned int timeout_ms) +/** + * Discard previously queued RX data. Internal to the serial subsystem, + * coordination between common and transport specific support code. + * + * @param[in] serial Previously opened serial port instance. + * + * @private + */ +SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial) { - ssize_t ret; - char *error; + if (!serial || !serial->rcv_buffer) + return; - if (!serial) { - sr_dbg("Invalid serial port."); - return SR_ERR; - } + g_string_truncate(serial->rcv_buffer, 0); +} - if (!serial->data) { - sr_dbg("Cannot use unopened serial port %s.", serial->port); - return SR_ERR; +/** + * Get amount of queued RX data. Internal to the serial subsystem, + * coordination between common and transport specific support code. + * + * @param[in] serial Previously opened serial port instance. + * + * @private + */ +SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial) +{ + if (!serial || !serial->rcv_buffer) + return 0; + + return serial->rcv_buffer->len; +} + +/** + * Queue received data. Internal to the serial subsystem, coordination + * between common and transport specific support code. + * + * @param[in] serial Previously opened serial port instance. + * @param[in] data Pointer to data bytes to queue. + * @param[in] len Number of data bytes to queue. + * + * @private + */ +SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial, + const uint8_t *data, size_t len) +{ + if (!serial || !data || !len) + return; + + if (serial->rx_chunk_cb_func) + serial->rx_chunk_cb_func(serial, serial->rx_chunk_cb_data, data, len); + else if (serial->rcv_buffer) + g_string_append_len(serial->rcv_buffer, (const gchar *)data, len); +} + +/** + * Retrieve previously queued RX data. Internal to the serial subsystem, + * coordination between common and transport specific support code. + * + * @param[in] serial Previously opened serial port instance. + * @param[out] data Pointer to store retrieved data bytes into. + * @param[in] len Number of data bytes to retrieve. + * + * @private + */ +SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial, + uint8_t *data, size_t len) +{ + size_t qlen; + GString *buf; + + if (!serial || !data || !len) + return 0; + + qlen = sr_ser_has_queued_data(serial); + if (!qlen) + return 0; + + buf = serial->rcv_buffer; + if (len > buf->len) + len = buf->len; + if (len) { + memcpy(data, buf->str, len); + g_string_erase(buf, 0, len); } - if (nonblocking) - ret = sp_nonblocking_write(serial->data, buf, count); - else - ret = sp_blocking_write(serial->data, buf, count, timeout_ms); + return len; +} - switch (ret) { - case SP_ERR_ARG: - sr_err("Attempted serial port write with invalid arguments."); - return SR_ERR_ARG; - case SP_ERR_FAIL: - error = sp_last_error_message(); - sr_err("Write error (%d): %s.", sp_last_error_code(), error); - sp_free_error_message(error); +/** + * Check for available receive data. + * + * @param[in] serial Previously opened serial port instance. + * + * @returns The number of (known) available RX data bytes. + * + * Returns 0 if no receive data is available, or if the amount of + * available receive data cannot get determined. + * + * @private + */ +SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial) +{ + size_t lib_count, buf_count; + + if (!serial) + return 0; + + lib_count = 0; + if (serial->lib_funcs && serial->lib_funcs->get_rx_avail) + lib_count = serial->lib_funcs->get_rx_avail(serial); + + buf_count = sr_ser_has_queued_data(serial); + + return lib_count + buf_count; +} + +static int _serial_write(struct sr_serial_dev_inst *serial, + const void *buf, size_t count, + int nonblocking, unsigned int timeout_ms) +{ + ssize_t ret; + + if (!serial) { + sr_dbg("Invalid serial port."); return SR_ERR; } + if (!serial->lib_funcs || !serial->lib_funcs->write) + return SR_ERR_NA; + ret = serial->lib_funcs->write(serial, buf, count, + nonblocking, timeout_ms); sr_spew("Wrote %zd/%zu bytes.", ret, count); return ret; @@ -289,7 +426,7 @@ static int _serial_write(struct sr_serial_dev_inst *serial, * @private */ SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial, - const void *buf, size_t count, unsigned int timeout_ms) + const void *buf, size_t count, unsigned int timeout_ms) { return _serial_write(serial, buf, count, 0, timeout_ms); } @@ -308,43 +445,25 @@ SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial, * @private */ SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial, - const void *buf, size_t count) + const void *buf, size_t count) { 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, unsigned int timeout_ms) +static int _serial_read(struct sr_serial_dev_inst *serial, + void *buf, size_t count, int nonblocking, unsigned int timeout_ms) { ssize_t ret; - char *error; if (!serial) { sr_dbg("Invalid serial port."); return SR_ERR; } - if (!serial->data) { - sr_dbg("Cannot use unopened serial port %s.", serial->port); - return SR_ERR; - } - - if (nonblocking) - ret = sp_nonblocking_read(serial->data, buf, count); - else - ret = sp_blocking_read(serial->data, buf, count, timeout_ms); - - switch (ret) { - case SP_ERR_ARG: - sr_err("Attempted serial port read with invalid arguments."); - return SR_ERR_ARG; - case SP_ERR_FAIL: - error = sp_last_error_message(); - sr_err("Read error (%d): %s.", sp_last_error_code(), error); - sp_free_error_message(error); - return SR_ERR; - } - + if (!serial->lib_funcs || !serial->lib_funcs->read) + return SR_ERR_NA; + ret = serial->lib_funcs->read(serial, buf, count, + nonblocking, timeout_ms); if (ret > 0) sr_spew("Read %zd/%zu bytes.", ret, count); @@ -360,14 +479,14 @@ static int _serial_read(struct sr_serial_dev_inst *serial, void *buf, * @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. If this is less than the number + * @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, unsigned int timeout_ms) +SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, + void *buf, size_t count, unsigned int timeout_ms) { return _serial_read(serial, buf, count, 0, timeout_ms); } @@ -381,13 +500,13 @@ 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) +SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, + void *buf, size_t count) { return _serial_read(serial, buf, count, 1, 0); } @@ -401,7 +520,7 @@ 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). * @@ -410,65 +529,67 @@ SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf * * @private */ -SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate, - int bits, int parity, int stopbits, - int flowcontrol, int rts, int dtr) +SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, + int baudrate, int bits, int parity, int stopbits, + int flowcontrol, int rts, int dtr) { int ret; - char *error; - struct sp_port_config *config; if (!serial) { sr_dbg("Invalid serial port."); return SR_ERR; } - if (!serial->data) { - sr_dbg("Cannot configure unopened serial port %s.", serial->port); - return SR_ERR; - } - sr_spew("Setting serial parameters on port %s.", serial->port); - sp_new_config(&config); - sp_set_config_baudrate(config, baudrate); - sp_set_config_bits(config, bits); - switch (parity) { - case 0: - sp_set_config_parity(config, SP_PARITY_NONE); - break; - case 1: - sp_set_config_parity(config, SP_PARITY_EVEN); - break; - case 2: - sp_set_config_parity(config, SP_PARITY_ODD); - break; - default: - return SR_ERR_ARG; + if (!serial->lib_funcs || !serial->lib_funcs->set_params) + return SR_ERR_NA; + ret = serial->lib_funcs->set_params(serial, + baudrate, bits, parity, stopbits, + flowcontrol, rts, dtr); + if (ret == SR_OK) { + serial->comm_params.bit_rate = baudrate; + serial->comm_params.data_bits = bits; + serial->comm_params.parity_bits = parity ? 1 : 0; + serial->comm_params.stop_bits = stopbits; + sr_dbg("DBG: %s() rate %d, %d%s%d", __func__, + baudrate, bits, + (parity == 0) ? "n" : "x", + stopbits); } - sp_set_config_stopbits(config, stopbits); - sp_set_config_rts(config, flowcontrol == 1 ? SP_RTS_FLOW_CONTROL : rts); - sp_set_config_cts(config, flowcontrol == 1 ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE); - sp_set_config_dtr(config, dtr); - sp_set_config_dsr(config, SP_DSR_IGNORE); - sp_set_config_xon_xoff(config, flowcontrol == 2 ? SP_XONXOFF_INOUT : SP_XONXOFF_DISABLED); - - ret = sp_set_config(serial->data, config); - sp_free_config(config); - - switch (ret) { - case SP_ERR_ARG: - sr_err("Invalid arguments for setting serial port parameters."); - return SR_ERR_ARG; - case SP_ERR_FAIL: - error = sp_last_error_message(); - sr_err("Error setting serial port parameters (%d): %s.", - sp_last_error_code(), error); - sp_free_error_message(error); + + return ret; +} + +/** + * Manipulate handshake state for the specified serial port. + * + * @param serial Previously initialized serial port structure. + * @param[in] rts Status of RTS line (0 or 1; or -1 to ignore). + * @param[in] dtr Status of DTR line (0 or 1; or -1 to ignore). + * + * @retval SR_OK Success. + * @retval SR_ERR Failure. + * + * @private + */ +SR_PRIV int serial_set_handshake(struct sr_serial_dev_inst *serial, + int rts, int dtr) +{ + int ret; + + if (!serial) { + sr_dbg("Invalid serial port."); return SR_ERR; } - return SR_OK; + sr_spew("Modifying serial parameters on port %s.", serial->port); + + if (!serial->lib_funcs || !serial->lib_funcs->set_handshake) + return SR_ERR_NA; + ret = serial->lib_funcs->set_handshake(serial, rts, dtr); + + return ret; } /** @@ -477,7 +598,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 * "/{/