X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fserial.c;h=fc7063882a259d6a1fe381ab3a20d60d69bb5a97;hb=e1b5b7e735608bcabb674d807f8321e9e8e00fa5;hp=4fe9b88fc0805e43b7716a4cdd1ace37501620a4;hpb=98edee7926b9827eec743bbfbfde9025089dc502;p=libsigrok.git diff --git a/src/serial.c b/src/serial.c index 4fe9b88f..fc706388 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 @@ -169,8 +170,46 @@ 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. + */ +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 +227,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: @@ -212,15 +251,17 @@ 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. */ 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); } /** @@ -237,11 +278,11 @@ SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial, 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 +300,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: @@ -284,15 +325,17 @@ 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 other The number of bytes read. If this is less than the number + * requested, the timeout was reached. */ 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); } /** @@ -310,7 +353,7 @@ SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf, 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); } /** @@ -678,18 +721,17 @@ SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_devic switch (src->key) { case SR_CONF_CONN: *serial_device = g_variant_get_string(src->data, NULL); - sr_dbg("Parsed serial device: %s", *serial_device); + sr_dbg("Parsed serial device: %s.", *serial_device); break; - case SR_CONF_SERIALCOMM: *serial_options = g_variant_get_string(src->data, NULL); - sr_dbg("Parsed serial options: %s", *serial_options); + sr_dbg("Parsed serial options: %s.", *serial_options); break; } } if (!*serial_device) { - sr_dbg("No serial device specified"); + sr_dbg("No serial device specified."); return SR_ERR; } @@ -765,6 +807,76 @@ SR_PRIV int serial_source_remove(struct sr_session *session, return SR_OK; } +/** + * Create/allocate a new sr_serial_port structure. + * + * @param name The OS dependent name of the serial port. Must not be NULL. + * @param description An end user friendly description for the serial port. + * Can be NULL (in that case the empty string is used + * as description). + * + * @return The newly allocated sr_serial_port struct. + */ +static struct sr_serial_port *sr_serial_new(const char *name, + const char *description) +{ + struct sr_serial_port *serial; + + if (!name) + return NULL; + + serial = g_malloc(sizeof(struct sr_serial_port)); + serial->name = g_strdup(name); + serial->description = g_strdup(description ? description : ""); + + return serial; +} + +/** + * Free a previously allocated sr_serial_port structure. + * + * @param serial The sr_serial_port struct to free. Must not be NULL. + */ +SR_API void sr_serial_free(struct sr_serial_port *serial) +{ + if (!serial) + return; + g_free(serial->name); + g_free(serial->description); + g_free(serial); +} + +/** + * List available serial devices. + * + * @return A GSList of strings containing the path of the serial devices or + * NULL if no serial device is found. The returned list must be freed + * by the caller. + */ +SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver) +{ + GSList *tty_devs = NULL; + struct sp_port **ports; + struct sr_serial_port *port; + int i; + + /* Currently unused, but will be used by some drivers later on. */ + (void)driver; + + if (sp_list_ports(&ports) != SP_OK) + return NULL; + + for (i = 0; ports[i]; i++) { + port = sr_serial_new(sp_get_port_name(ports[i]), + sp_get_port_description(ports[i])); + tty_devs = g_slist_append(tty_devs, port); + } + + sp_free_port_list(ports); + + return tty_devs; +} + /** * Find USB serial devices via the USB vendor ID and product ID. * @@ -784,13 +896,55 @@ SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id) if (sp_list_ports(&ports) != SP_OK) return NULL; - for (i=0; ports[i]; i++) + for (i = 0; ports[i]; i++) if (sp_get_port_transport(ports[i]) == SP_TRANSPORT_USB && sp_get_port_usb_vid_pid(ports[i], &vid, &pid) == SP_OK && - vid == vendor_id && pid == product_id) + vid == vendor_id && pid == product_id) { tty_devs = g_slist_prepend(tty_devs, - g_strdup(sp_get_port_name(ports[i]))); + g_strdup(sp_get_port_name(ports[i]))); + } sp_free_port_list(ports); + return tty_devs; } + +SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes) +{ + struct sp_port_config *config; + int timeout_ms, bits, baud, tmp; + + /* Default to 1s. */ + timeout_ms = 1000; + + if (sp_new_config(&config) < 0) + return timeout_ms; + + bits = baud = 0; + do { + if (sp_get_config(port->data, config) < 0) + break; + + /* Start bit. */ + bits = 1; + if (sp_get_config_bits(config, &tmp) < 0) + break; + bits += tmp; + if (sp_get_config_stopbits(config, &tmp) < 0) + break; + bits += tmp; + if (sp_get_config_baudrate(config, &tmp) < 0) + break; + baud = tmp; + } while (FALSE); + + if (bits && baud) { + /* Throw in 10ms for misc OS overhead. */ + timeout_ms = 10; + timeout_ms += ((1000.0 / baud) * bits) * num_bytes; + } + + sp_free_config(config); + + return timeout_ms; +}