/* * This file is part of the libsigrok project. * * Copyright (C) 2010-2012 Bert Vermeulen * Copyright (C) 2010-2012 Uwe Hermann * Copyright (C) 2012 Alexandru Gagniuc * * 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 * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include #include #include #include #include #include "libsigrok.h" #include "libsigrok-internal.h" #define LOG_PREFIX "serial" /** * 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, SERIAL_NONBLOCK. * * 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. */ 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."); return SR_ERR; } 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; serial->nonblocking = (flags & SERIAL_NONBLOCK) ? 1 : 0; ret = sp_open(serial->data, sp_flags); 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; } if (serial->serialcomm) return serial_set_paramstr(serial, serial->serialcomm); else return SR_OK; } /** * Close the specified serial port. * * @param serial Previously initialized serial port structure. * * @retval SR_OK Success. * @retval SR_ERR Failure. */ SR_PRIV int serial_close(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 close unopened serial port %s.", serial->port); return SR_ERR; } sr_spew("Closing serial port %s.", serial->port); ret = sp_close(serial->data); 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; } sp_free_port(serial->data); serial->data = NULL; return SR_OK; } /** * Flush serial port buffers. * * @param serial Previously initialized serial port structure. * * @retval SR_OK Success. * @retval SR_ERR Failure. */ 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); 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; } return SR_OK; } static int _serial_write(struct sr_serial_dev_inst *serial, const void *buf, size_t count, int nonblocking) { 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_write(serial->data, buf, count); else ret = sp_blocking_write(serial->data, buf, count, 0); 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); return SR_ERR; } sr_spew("Wrote %d/%d bytes.", ret, count); return ret; } /** * Write a number of bytes to the specified serial port. * * @param serial Previously initialized serial port structure. * @param[in] buf Buffer containing the bytes to write. * @param[in] count Number of bytes to write. * * @retval SR_ERR_ARG Invalid argument. * @retval SR_ERR Other error. * @retval other The number of bytes written. */ SR_PRIV int serial_write(struct sr_serial_dev_inst *serial, const void *buf, size_t count) { return _serial_write(serial, buf, count, serial->nonblocking); } /** * Write a number of bytes to the specified serial port, blocking until finished. * @copydetails serial_write() */ SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial, const void *buf, size_t count) { return _serial_write(serial, buf, count, 0); } /** * Write a number of bytes to the specified serial port, return immediately. * @copydetails serial_write() */ 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); } static int _serial_read(struct sr_serial_dev_inst *serial, void *buf, size_t count, int nonblocking) { 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, 0); 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 (ret > 0) sr_spew("Read %d/%d bytes.", ret, count); return ret; } /** * Read a number of bytes from the specified serial port. * * @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. * * @retval SR_ERR_ARG Invalid argument. * @retval SR_ERR Other error. * @retval other The number of bytes read. */ SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf, size_t count) { return _serial_read(serial, buf, count, serial->nonblocking); } /** * Read a number of bytes from the specified serial port, block until finished. * @copydetails serial_read() */ SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf, size_t count) { return _serial_read(serial, buf, count, 0); } /** * Try to read up to @a count bytes from the specified serial port, return * immediately with what's available. * @copydetails serial_read() */ SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf, size_t count) { return _serial_read(serial, buf, count, 1); } /** * Set serial parameters for the specified serial port. * * @param serial Previously initialized serial port structure. * @param[in] baudrate The baudrate to set. * @param[in] bits The number of data bits to use (5, 6, 7 or 8). * @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). * @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. */ 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; } 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 SR_ERR; } return SR_OK; } /** * Set serial parameters for the specified serial port from parameter string. * * @param serial Previously initialized serial port structure. * @param[in] paramstr A serial communication parameters string of the form * "/{/