X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fserial.c;h=27244da34b6513c6e0cc4b9461fd4d417b3f652b;hb=45884333ff8641c86d9808b46dde9f571083c10d;hp=fc7063882a259d6a1fe381ab3a20d60d69bb5a97;hpb=b1a7ca3b605a8a7e7ce97dfc9eb211e9b3a5c918;p=libsigrok.git
diff --git a/src/serial.c b/src/serial.c
index fc706388..27244da3 100644
--- a/src/serial.c
+++ b/src/serial.c
@@ -20,15 +20,35 @@
* 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.
@@ -42,6 +62,8 @@
*
* @retval SR_OK Success.
* @retval SR_ERR Failure.
+ *
+ * @private
*/
SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
{
@@ -90,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)
{
@@ -135,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)
{
@@ -177,6 +203,8 @@ SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
*
* @retval SR_OK Success.
* @retval SR_ERR Failure.
+ *
+ * @private
*/
SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial)
{
@@ -240,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;
}
@@ -257,6 +285,8 @@ static int _serial_write(struct sr_serial_dev_inst *serial,
* @retval SR_ERR Other error.
* @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, unsigned int timeout_ms)
@@ -274,7 +304,9 @@ 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)
{
@@ -314,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;
}
@@ -331,6 +363,8 @@ static int _serial_read(struct sr_serial_dev_inst *serial, void *buf,
* @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)
@@ -349,6 +383,8 @@ SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
* @retval SR_ERR_ARG Invalid argument.
* @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)
@@ -371,6 +407,8 @@ SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf
*
* @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,
@@ -450,13 +488,18 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
* rts=0|1 Set RTS off resp. on.\n
* Please note that values and combinations of these parameters must be
* supported by the concrete serial interface hardware and the drivers for it.
+ *
* @retval SR_OK Success.
* @retval SR_ERR Failure.
+ *
+ * @private
*/
SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
const char *paramstr)
{
+/** @cond PRIVATE */
#define SERIAL_COMM_SPEC "^(\\d+)/([5678])([neo])([12])(.*)$"
+/** @endcond */
GRegex *reg;
GMatchInfo *match;
@@ -477,13 +520,13 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
if ((mstr = g_match_info_fetch(match, 3))) {
switch (mstr[0]) {
case 'n':
- parity = SERIAL_PARITY_NONE;
+ parity = SP_PARITY_NONE;
break;
case 'e':
- parity = SERIAL_PARITY_EVEN;
+ parity = SP_PARITY_EVEN;
break;
case 'o':
- parity = SERIAL_PARITY_ODD;
+ parity = SP_PARITY_ODD;
break;
}
}
@@ -561,6 +604,8 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
*
* @retval SR_OK Success.
* @retval SR_ERR Failure.
+ *
+ * @private
*/
SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
int *buflen, gint64 timeout_ms)
@@ -583,7 +628,7 @@ SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
maxlen = *buflen;
*buflen = len = 0;
- while(1) {
+ while (1) {
len = maxlen - *buflen - 1;
if (len < 1)
break;
@@ -628,6 +673,8 @@ SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
*
* @retval SR_OK Valid packet was found within the given timeout.
* @retval SR_ERR Failure.
+ *
+ * @private
*/
SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
uint8_t *buf, size_t *buflen,
@@ -637,7 +684,7 @@ SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
{
uint64_t start, time, byte_delay_us;
size_t ibuf, i, maxlen;
- int len;
+ ssize_t len;
maxlen = *buflen;
@@ -650,7 +697,7 @@ SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
}
/* Assume 8n1 transmission. That is 10 bits for every byte. */
- byte_delay_us = 10 * (1000000 / baudrate);
+ byte_delay_us = 10 * ((1000 * 1000) / baudrate);
start = g_get_monotonic_time();
i = ibuf = len = 0;
@@ -670,12 +717,12 @@ SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
if ((ibuf - i) >= packet_size) {
/* We have at least a packet's worth of data. */
if (is_valid(&buf[i])) {
- sr_spew("Found valid %d-byte packet after "
+ sr_spew("Found valid %zu-byte packet after "
"%" PRIu64 "ms.", (ibuf - i), time);
*buflen = ibuf;
return SR_OK;
} else {
- sr_spew("Got %d bytes, but not a valid "
+ sr_spew("Got %zu bytes, but not a valid "
"packet.", (ibuf - i));
}
/* Not a valid packet. Continue searching. */
@@ -683,7 +730,7 @@ SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
}
if (time >= timeout_ms) {
/* Timeout */
- sr_dbg("Detection timed out after %dms.", time);
+ sr_dbg("Detection timed out after %" PRIu64 "ms.", time);
break;
}
if (len < 1)
@@ -692,7 +739,7 @@ SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
*buflen = ibuf;
- sr_err("Didn't find a valid packet (read %d bytes).", *buflen);
+ sr_err("Didn't find a valid packet (read %zu bytes).", *buflen);
return SR_ERR;
}
@@ -701,12 +748,14 @@ SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
* Extract the serial device and options from the options linked list.
*
* @param options List of options passed from the command line.
- * @param serial_device Pointer where to store the exctracted serial device.
+ * @param serial_device Pointer where to store the extracted serial device.
* @param serial_options Pointer where to store the optional extracted serial
* options.
*
* @return SR_OK if a serial_device is found, SR_ERR if no device is found. The
* returned string should not be freed by the caller.
+ *
+ * @private
*/
SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
const char **serial_options)
@@ -738,20 +787,30 @@ SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_devic
return SR_OK;
}
-#ifdef _WIN32
+/** @cond PRIVATE */
+#ifdef G_OS_WIN32
typedef HANDLE event_handle;
#else
typedef int event_handle;
#endif
+/** @endcond */
+/** @private */
SR_PRIV int serial_source_add(struct sr_session *session,
struct sr_serial_dev_inst *serial, int events, int timeout,
sr_receive_data_callback cb, void *cb_data)
{
+ struct sp_event_set *event_set;
+ gintptr poll_fd;
+ unsigned int poll_events;
enum sp_event mask = 0;
- unsigned int i;
- if (sp_new_event_set(&serial->event_set) != SP_OK)
+ if ((events & (G_IO_IN|G_IO_ERR)) && (events & G_IO_OUT)) {
+ sr_err("Cannot poll input/error and output simultaneously.");
+ return SR_ERR_ARG;
+ }
+
+ if (sp_new_event_set(&event_set) != SP_OK)
return SR_ERR;
if (events & G_IO_IN)
@@ -761,50 +820,44 @@ SR_PRIV int serial_source_add(struct sr_session *session,
if (events & G_IO_ERR)
mask |= SP_EVENT_ERROR;
- if (sp_add_port_events(serial->event_set, serial->data, mask) != SP_OK) {
- sp_free_event_set(serial->event_set);
+ if (sp_add_port_events(event_set, serial->data, mask) != SP_OK) {
+ sp_free_event_set(event_set);
return SR_ERR;
}
-
- serial->pollfds = (GPollFD *) g_malloc0(sizeof(GPollFD) * serial->event_set->count);
-
- for (i = 0; i < serial->event_set->count; i++) {
-
- serial->pollfds[i].fd = ((event_handle *) serial->event_set->handles)[i];
-
- mask = serial->event_set->masks[i];
-
- if (mask & SP_EVENT_RX_READY)
- serial->pollfds[i].events |= G_IO_IN;
- if (mask & SP_EVENT_TX_READY)
- serial->pollfds[i].events |= G_IO_OUT;
- if (mask & SP_EVENT_ERROR)
- serial->pollfds[i].events |= G_IO_ERR;
-
- if (sr_session_source_add_pollfd(session, &serial->pollfds[i],
- timeout, cb, cb_data) != SR_OK)
- return SR_ERR;
+ if (event_set->count != 1) {
+ sr_err("Unexpected number (%u) of event handles to poll.",
+ event_set->count);
+ sp_free_event_set(event_set);
+ return SR_ERR;
}
- return SR_OK;
+ poll_fd = (gintptr) ((event_handle *)event_set->handles)[0];
+ mask = event_set->masks[0];
+
+ sp_free_event_set(event_set);
+
+ poll_events = 0;
+ if (mask & SP_EVENT_RX_READY)
+ poll_events |= G_IO_IN;
+ if (mask & SP_EVENT_TX_READY)
+ poll_events |= G_IO_OUT;
+ if (mask & SP_EVENT_ERROR)
+ poll_events |= G_IO_ERR;
+ /*
+ * Using serial->data as the key for the event source is not quite
+ * proper, as it makes it impossible to create another event source
+ * for the same serial port. However, these fixed keys will soon be
+ * removed from the API anyway, so this is OK for now.
+ */
+ return sr_session_fd_source_add(session, serial->data,
+ poll_fd, poll_events, timeout, cb, cb_data);
}
+/** @private */
SR_PRIV int serial_source_remove(struct sr_session *session,
struct sr_serial_dev_inst *serial)
{
- unsigned int i;
-
- for (i = 0; i < serial->event_set->count; i++)
- if (sr_session_source_remove_pollfd(session, &serial->pollfds[i]) != SR_OK)
- return SR_ERR;
-
- g_free(serial->pollfds);
- sp_free_event_set(serial->event_set);
-
- serial->pollfds = NULL;
- serial->event_set = NULL;
-
- return SR_OK;
+ return sr_session_source_remove_internal(session, serial->data);
}
/**
@@ -886,6 +939,8 @@ SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver)
* @return A GSList of strings containing the path of the serial device or
* NULL if no serial device is found. The returned list must be freed
* by the caller.
+ *
+ * @private
*/
SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id)
{
@@ -909,6 +964,7 @@ SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id)
return tty_devs;
}
+/** @private */
SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes)
{
struct sp_port_config *config;
@@ -948,3 +1004,5 @@ SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes)
return timeout_ms;
}
+
+/** @} */